Repository navigation
fix(release): generate release notes from the previous final tag - #455
Merged
Merged
Conversation
Collaborator
✅ Heimdall Review Status
|
xenoliss
approved these changes
Oct 16, 2026
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.
What changed? Why?
Publish Release now passes
--notes-start-tagtogh release create, so the generated notes always start at the previous final release.Without a start tag, GitHub uses the most recent release tag in the new tag's history. Final tags are cut on
releases/v*branches, and any commit made only on that branch keeps the tag out ofmain. Minor and major release branches are created frommain, so they usually can't see the previous final tag. For v8.4.0, GitHub skipped v8.3.0 and generated notes from v8.2.0, which listed about 50 PRs instead of the 8 that were new. v8.1.0, v8.2.1, v8.3.0 and v8.4.0 are all missing frommaintoday, so the next minor release would compare against v8.2.0 too.The new
get_previous_final_taghelper inscripts/release/common.shreturns the highestvX.Y.Ztag below the version being released. RC tags in either format are ignored. If no earlier final tag exists, the workflow omits the flag and GitHub falls back to its default.Notes to reviewers
The tag being released is excluded on purpose. Publish Release creates the final tag before it creates the draft, so a plain "latest final tag" lookup would return the release's own tag.
A patch on an older line (for example v8.3.1 after v8.4.0 exists) compares against v8.3.0, not v8.4.0.
How has it been tested?
scripts/release/test-release.shfor RC tags, version ordering (8.10 above 8.9), excluding the version being released, a patch on an older line, and the first release../scripts/release/test-release.shpasses.shellcheck scripts/release/*.shandactionlint .github/workflows/publish-release.ymlpass.Generated with Toshi