fix: rolling release notes cover only the span since the previous ship#79
Merged
Conversation
The reused rolling release called generate_release_notes on every update, and the generated 'What's Changed' accumulated onto the existing body each ship — after a high-volume day the description grew unreadably long. Auto-ship now generates notes explicitly for previous-rolling-tag -> shipped-commit (before the tag force-moves) via the generate-notes API and replaces the body outright; the compare link is rewritten to real SHAs since the synthetic tag never exists. Milestone v* tag releases are fresh releases and keep GitHub-generated notes.
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 this does
The rolling release's description accumulated every past ship's "What's Changed" and had grown unreadably long. Each auto-ship now replaces the body with notes scoped to exactly the commits since the previous ship.
Summary
rolling_notesstep (before the tag force-move) calls the generate-notes API withprevious_tag_name: rolling→ the span since last ship; compare link rewritten to real SHAsbody(replaces —append_bodydefaults to false) and only enablesgenerate_release_notesfor milestonev*tag releases, which are fresh releasesTest Plan