ci(release): auto-populate GitHub release notes and changelog sections#128
Merged
Conversation
- Pass `generate_release_notes: true` to softprops/action-gh-release so the published GitHub release body is auto-built from merged PRs since the previous tag (currently empty for v0.6.0 and earlier). - Pass `--bump v$RELEASE_VERSION` to git-changelog so CHANGELOG.md gets a proper versioned section per release instead of perpetually showing only "Unreleased". The `v` prefix matches the existing tag scheme. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.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.
Summary
The current release pipeline cuts a tag, publishes to PyPI, and creates an empty GitHub release. v0.6.0 (which shipped websocket gateways) has
body: ""andCHANGELOG.mdonly contains an empty## Unreleasedblock — so launches go out silently.Two one-line fixes:
generate_release_notes: trueonsoftprops/action-gh-release@v2. GitHub builds the release body from merged PRs since the previous tag (titles, authors, full-changelog link). No commit-message format dependency.--bump "v$RELEASE_VERSION"ongit-changelog. Without it, the tool can't promote theUnreleasedblock into a versioned section, soCHANGELOG.mdnever accumulates entries. Thevprefix matches the existing tag scheme so compare links resolve.Test plan
release.yaml(workflow_dispatch,patch) once this is mergedCHANGELOG.mdonmaingains a## [vX.Y.Z]section after the run