ci(release): scope release notes to each module#131
Merged
Conversation
GitHub's generate_release_notes lists every PR in the commit range and has no path filtering, so the SDK/Contrib/Admin drafts all repeated the full cross-module changelog. Replace it with .github/scripts/release-notes.sh, which keeps only PRs whose changed files touched the released module's directory (carving the keyvault submodule out of contrib), and feed the result via body_path. Add fetch-depth: 0 to the SDK and Contrib checkouts so the previous module tag is resolvable. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
qarlosh
approved these changes
Jul 3, 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.
What
The release workflow used
generate_release_notes: true, which lists every PR in the tag's commit range with no path filtering. In this monorepo that meant the SDK, Contrib, and Admin draft releases all repeated the same full cross-module changelog (e.g. theadmin/v0.1.1draft listed core cert-renewal and forward-routing PRs).This replaces the auto-notes with
.github/scripts/release-notes.sh, which:The pretty
* title by @author in #PRformat and theNew Contributorssection are preserved; the latter only survives if its PR did. Output is fed toaction-gh-releaseviabody_path.Module boundaries
core(root)sdk/,plugins/contrib/,admin/,.github/,docs/,.ai/— soplugins/reference/(no owngo.mod) correctly counts as coresdksdk/contribplugins/contrib/but notplugins/contrib/microsoft/keyvault/(separate module)adminadmin/PRs touching only
.github/(CI action bumps) or only the keyvault submodule drop out of all release notes.Other changes
permissions: pull-requests: readadded — the script reads changed files via the PRs API, and an explicitpermissions:block sets unlisted scopes tonone.fetch-depth: 0added to the SDK and Contrib checkouts so the previous module tag is resolvable.Testing
Ran the script locally against all four real
v0.3.0-era tags; output matches the manually-filtered drafts. Note this only affects the next release after merge — the current drafts were already filtered by hand.🤖 Generated with Claude Code