Source release notes from CHANGELOG.md instead of hardcoded bullets#30
Merged
Conversation
build_release.sh was generating RELEASE_NOTES.txt with a hardcoded
"What's New" block that hadn't been updated since v1.0.4. The dynamic
\${VERSION} interpolation made the staleness invisible until v1.2.0
shipped with v1.0.4's bullet list. The release workflow consumes this
file as the GitHub release body, so the stale text became public.
Now extracts the matching version's section from CHANGELOG.md using
awk. Falls back to a CHANGELOG.md pointer when no matching section is
found (e.g. missing file, version mismatch).
DmitriiAn
approved these changes
May 27, 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.
Summary
build_release.shwas generatingRELEASE_NOTES.txtwith a hardcoded "What's New" block that hadn't been updated since v1.0.4. Because the${VERSION}interpolation was dynamic, the staleness was invisible — until v1.2.0 shipped with v1.0.4's bullet list as its release notes (the release workflow uses this file as the GitHub release body).The live v1.2.0 release notes have been hand-corrected via
gh release edit. This PR prevents the same drift from happening on v1.3.0+.Approach
Extract the matching version's section from
CHANGELOG.mdwith awk:Falls back to a "See CHANGELOG.md" pointer when no matching section is found.
Test plan
bash build_release.sh(reads VERSION=1.2.0) —RELEASE_NOTES.txt"What's New" matches the[1.2.0]section ofCHANGELOG.mdbash build_release.sh 9.9.9— prints a warning and falls back to "See CHANGELOG.md for changes in this release."