Repository navigation
👷 Start release.yml by dispatching it on the tag, and publish the CHANGELOG's notes - #6
Merged
Merged
Conversation
…n the tag push, and publish the CHANGELOG's notes
Three parts — what and why, how to test, a two-line checklist — so every PR answers the same questions, with the title format and the emoji-to-version mapping as a comment at the top. Kept deliberately small; the full rules stay in CONTRIBUTING.md.
…th no notes stops first
diegomarty
force-pushed
the
fix/release-trigger
branch
from
October 24, 2026 14:41
3fb4a3a to
60aa327
Compare
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
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.
0.5.0 and 1.0.0 were tagged by
bump.ymlbut never released: the tag reached GitHub andrelease.ymlnever started. Both GitHub releases had to be created by hand.Why
bump.ymlrelied on the tag push itself to startrelease.yml. That needed the push to be made with a PAT (RELEASE_TOKEN), and it needed the trick of blanking the credential thatactions/checkoutpersists to actually take effect. It did not, twice: GitHub starts no workflow run for a push it attributes to the workflow's ownGITHUB_TOKEN.The release notes were also wrong:
release.ymlused GitHub's generated list of pull requests instead of the hand-written CHANGELOG notes that gate every release.Changes
bump.ymlpushes the commit and the tag withGITHUB_TOKEN, so they start nothing. It then dispatchesrelease.ymlon the tag withgh workflow run release.yml --ref vX.Y.Z. Aworkflow_dispatchmade withGITHUB_TOKENis GitHub's documented exception and does start a run, so every tag gets exactly one release run.RELEASE_TOKENis no longer used. The secret can be deleted once this is merged.release.ymlalso acceptsworkflow_dispatchon a tag ref. The existing tag-vs-package.jsoncheck refuses any other ref. The release's notes come fromchangelog.sh notes <version>(body_path).changelog.sh notes <version>prints that version's section. It fails on a missing or empty section, so a release can never go out with empty notes.Verification
test/release-workflows.test.tspins the notes extraction (including the failure on a missing version), the dispatch, and the notes source. Three of its tests failed before these changes.make checkpasses: 1309 tests, Prettier clean.v1.0.0. It re-runs the gates and updates the existing 1.0.0 release with the CHANGELOG notes.