Change release CI flow to actually use our CHANGELOG.md notes#80
Merged
Conversation
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.
Our previous release flow was having GitHub's AI automatically generate the changelogs in the official release. These differed somewhat from our actual
CHANGELOG.mdnotes. Because many automations rely on these Release notes as the main changelog, this change ensures that they're always in sync. Our current flow is to always push a changelog update before tagging and releasing, so this flow should work well.Note
Low Risk
Only affects release automation and maintainer docs; releases now fail fast if the changelog section is missing, which is intentional guardrail behavior.
Overview
GitHub releases now publish the same text as
CHANGELOG.mdinstead of auto-generated notes.The release workflow adds an Extract release notes step that pulls the
## [version]section for the tag (stripping thevprefix) intorelease-notes.md, and fails the job if that section is empty.gh release createthen uses--notes-file release-notes.mdinstead of--generate-notes.The Releasing section in the README tells maintainers to review the matching changelog entry before tagging, since that section becomes the official release notes.
Reviewed by Cursor Bugbot for commit 3703fb5. Bugbot is set up for automated code reviews on this repo. Configure here.