Skip to content

fix: ensure tag script releases to the correct default branch #1903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 22, 2024
Merged

fix: ensure tag script releases to the correct default branch #1903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbec865
fix: ensure `tag` script releases to the correct default branch
jzempel Aug 22, 2024
92d93f9
Remove coveralls reporting, currently responding with a 500 error
jzempel Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,6 @@ jobs:
path: packages

- run: npm run test:ci
- run: npm exec -- coveralls < .cache/coverage/lcov.info
env:
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}

deploy-staging:
if: >
Expand Down
9 changes: 5 additions & 4 deletions utils/scripts/tag.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,21 @@ const changelog = async (tag, spinner) => {
/**
* Push a GitHub release.
*
* @param {String} main Name for the main branch being released.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit]

Suggested change
* @param {String} main Name for the main branch being released.
* @param {String} defaultBranch Name for the default branch being released.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually maybe branch rather than defaultBranch might more suitable.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never mind. The version script uses main too. It might be better to keep as is for consistency.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

am i misinterpreting the argument or is main the name of the actual branch, or is it just whichever branch is provided to the script? 🤔

* @param {String} tag The tag for the new release.
* @param {String} markdown Markdown content.
* @param {Ora} spinner Terminal spinner.
*
* @returns The draft release URL.
*/
const release = async (tag, markdown, spinner) => {
const release = async (main, tag, markdown, spinner) => {
info('Creating release...', spinner);

const pushArgs = ['push', '--follow-tags', '--no-verify', '--atomic', 'origin'];

// Ensure `version` commit hits CI, triggering npm publish
await execa('git', pushArgs.concat('HEAD^:main'));
await execa('git', pushArgs.concat('main'));
await execa('git', pushArgs.concat(`HEAD^:${main}`));
await execa('git', pushArgs.concat(main));

const url = await githubRelease({ tag, body: markdown, spinner });

Expand Down Expand Up @@ -221,7 +222,7 @@ program
]);

if (prompt.release) {
await release(tag, markdown, spinner);
await release(program.opts().main, tag, markdown, spinner);
} else {
await rollback(tag, spinner);
}
Expand Down