(maint) Fix release-notes.md and auto-generate from CHANGELOG in release workflow#698
Merged
(maint) Fix release-notes.md and auto-generate from CHANGELOG in release workflow#698
Conversation
shubhamperforce
approved these changes
Mar 19, 2026
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
2 participants
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.
Problem
release-notes.mdwas never updated between releases — every release was using the same stale 3.8.1 content as the GitHub release body. This affected the 3.8.1, 3.9.0, and 3.9.1 GitHub release pages.Fix
release-notes.mdto the correct 3.9.1 content (Wire RateLimiter middleware (P4DEVOPS-9434) Wire RateLimiter middleware into API Rack stack #696)release.yml— added a step that auto-generatesrelease-notes.mdfrom the current version's section inCHANGELOG.mdbefore creating the GitHub release. This prevents the issue from recurring.The
awkcommand extracts the section between the current version header and the next version header in CHANGELOG.md.Note on previous releases
The gem binaries for 3.8.1, 3.9.0, and 3.9.1 are correct on RubyGems — only the GitHub release bodies had wrong content. The 3.9.1 body will be corrected by re-running the release workflow after this PR is merged.