ci(release): create the GitHub Release, not just the tag - #59
Merged
Conversation
The release workflow tagged and published but never touched the Releases page, so what shipped was invisible where people actually look for it: v1.5.0 had to be written by hand, and v1.5.1 and v1.6.0 were missing from the list entirely while being live on npm. The tags were always there - a tag and a Release are different objects, and only the tag was being created. The notes come from core's own CHANGELOG section for the version being released, so there is one source of truth and nothing to keep in sync by hand, preceded by the four package versions that shipped. An existing release is left alone rather than failing the step, so re-running the workflow after a partial failure stays safe. `contents: write` was already granted for the version commit and the tag push, so this needs no new permission.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
v1.6.0is live on npm and tagged, but it did not appear on the Releases page — because the workflow never created a Release there. A git tag and a GitHub Release are different objects, and only the tag was ever created.This adds the step that closes the gap.
packages/core/CHANGELOG.md, the section for the version being released — one source of truth, nothing to keep in sync by hand — preceded by the four package versions that shipped.--verify-tag, so it can never create a release pointing at a tag the publish step failed to push.contents: writewas already granted for the version commit and the tag push.Verified locally by generating the notes for 1.6.0 with the same
awkextraction and checking the section boundaries, and by parsing the workflow to confirm the step lands betweenPublish to npmandDry run summaryand is skipped underdry_run.v1.5.1still has no Release entry. Say the word and I will write one, but it is history rather than something this fixes.