ci: stable-style changelog notes for pre-releases - #162
Merged
Conversation
Replace the generic pre-release body with the pending version's section from release-please's CHANGELOG.md (read off its release-PR branch) — the same grouped Features / Bug Fixes notes the stable release will ship, so each pre-release previews exactly what's coming in v<base>. Falls back to a short note when no release PR is open. Body is assembled in a file via printf to keep markdown intact. Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
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.
What
Pre-release GitHub releases currently show a generic body ("Automated pre-release built from main (sha)…"). This makes the body a real stable-style changelog instead.
How
In the
Create draft pre-releasestep, read release-please's pendingCHANGELOG.mdfrom its release-PR branch (release-please--branches--main--components--mcpmux) and extract the top (pending) version section — the same grouped Features / Bug Fixes / … notes the eventual stablev<base>will ship. So eachv0.4.0-<run>pre-release previews exactly what's coming inv0.4.0, including the## [0.4.0](compare) (date)header.body.mdviaprintfand passed with-f body="$(cat body.md)", so markdown stays intact (no YAML block-scalar indentation leaking in, no column-0 break).CHANGELOG.mdproduced clean markdown; YAML validated; pre-commit hook green.Note on versioning
The version keeps its numeric pre-release suffix (
0.4.0-186) — that's required so the updater can order pre-release vs stable and so the Windows MSI bundles. Only the notes now mirror stable; the version intentionally stays distinguishable.