Generate release notes from the merged pull requests - #217
Merged
Conversation
Notes came from the tagged commit, and since the workflow creates the tag itself that meant whatever landed last — the alpha release ended up carrying the previous PR's description. Generate them instead, against the last full release, so the notes list what actually changed since the version people are on.
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.
Release notes came from the tagged commit, and since #215 the workflow creates that tag itself — so the notes ended up being whatever landed last. The alpha shipped carrying #215's own description, which had nothing to do with what was in the release.
This generates them instead, from the pull requests merged since the last full release.
The start tag comes from
repos/{repo}/releases/latest, which skips prereleases and drafts. That matters here: without it, 1.30.0's notes would be computed against1.30.0-alpha.1and come out nearly empty, rather than listing everything since 1.29.0 — the version people are actually on.Generated notes are a floor, not a ceiling. They list merged PRs by title, which is a reasonable default; a release worth describing still wants a hand-written top, via
gh release editor the GitHub UI.Test plan
Can't be exercised without publishing. Next release should open with a "What's Changed" list of the PRs merged since 1.29.0, rather than a copy of the previous PR's description.