ci: use GitHub native release notes generator (fixes #225) - #233
Merged
Conversation
Replace the abandoned heinrichreimer/github-changelog-generator-action (last release 2022) and InsonusK/get-latest-release with softprops/action-gh-release's built-in generate_release_notes option, which calls GitHub's /releases/generate-notes API server-side. This also fixes the %0A line-break encoding in release bodies (#225): the previous flow interpolated the changelog action's output through ${{ }} into a body string, which exposed legacy ::set-output:: URL encoding now that GitHub Actions has stopped auto-decoding it. generate_release_notes bypasses string interpolation entirely. Categorization (Features / Bug Fixes / Other) can be tuned later by adding an optional .github/release.yml config.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR simplifies the release workflow by switching from a third-party changelog generator to GitHub’s native release notes generation via softprops/action-gh-release, addressing the %0A newline encoding issue described in #225.
Changes:
- Removed the previous-release lookup step that only fed the old changelog action.
- Removed the abandoned changelog generator action.
- Enabled
generate_release_notes: truewhen creating GitHub Releases.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
heinrichreimer/github-changelog-generator-action@v2.4(last release 2022) withsoftprops/action-gh-release's built-ingenerate_release_notes: true, which calls GitHub's/releases/generate-notesAPI server-side.InsonusK/get-latest-release@v1.1.0step (another abandoned action; only existed to feedsinceTagto the changelog generator).%0Aline-break encoding in v1.2.0 and v1.2.1 release bodies. Root cause is that the changelog action still used the deprecated::set-output::URL-encoded format; GitHub Actions stopped auto-decoding%0Ato newlines, so the encoded form leaked into thebody:string. Switching togenerate_release_notesbypasses${{ }}interpolation of the changelog text entirely, which structurally eliminates that class of bug.Test plan
pytestpasses (21 tests)ruff checkcleanruff format --checkclean (with ruff 0.15.12 matching>=0.15.0pin)%0AOptional follow-up: add
.github/release.ymlto group PRs by label (Features / Bug Fixes / Other) — left out of this PR to keep the diff minimal.🤖 Generated with Claude Code