🔧 config(release): use CHANGELOG section as GitHub Release notes#14
Merged
Conversation
- 🔧 config: github-release extracts the tag's CHANGELOG.md version section (read from the tag itself) and prepends it to the auto-generated PR list; falls back to generated notes alone when no section matches - 📝 docs: document the notes behavior in docs/RELEASE.md and the CHANGELOG [Unreleased] section
biggest-littlest
approved these changes
Jun 12, 2026
biggest-littlest
left a comment
biggest-littlest
left a comment
Member
There was a problem hiding this comment.
Reviewed the notes-extraction script: pipefail-safe, reads CHANGELOG from the tag, clean fallback when no section matches. CI green. LGTM.
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
github-releasejob now extracts the matching version section fromCHANGELOG.mdand uses it as the GitHub Release body, with the auto-generated PR list + compare link appended after it (ghprepends--notes-filecontent to--generate-notesoutput).git show refs/tags/<tag>:CHANGELOG.md), soworkflow_dispatchbackfills get the correct version's notes even aftermainmoves on.docs/RELEASE.md; CHANGELOG[Unreleased]entry added.Closes the gap where v0.3.7's release notes had to be hand-curated after the fact — future releases get the curated body automatically.
Verification
set -euo pipefailfor all three paths: section hit (v0.3.7 → 28 lines), no matching section (fallback), missing tag/file (fallback).release.ymlparses as valid YAML.npm run cigreen: 253 unit/integration + 16 e2e, 0 failures.