ci(release): scope release notes to each module #131
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| #!/usr/bin/env bash | ||
| # Copyright 2026 CloudBlue LLC | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # | ||
| # Generate PR-level release notes scoped to a single module. | ||
| # | ||
| # Usage: release-notes.sh <current_tag> <tag_glob> <module_key> | ||
| # current_tag e.g. sdk/v0.3.0 | ||
| # tag_glob e.g. 'sdk/v*' (finds the previous tag of the SAME module) | ||
| # module_key one of: core | sdk | contrib | admin | ||
| # | ||
| # Emits a "## What's Changed" list containing only the PRs whose changed files | ||
| # touched the given module's directory, followed by a filtered | ||
| # "## New Contributors" section and the module-scoped Full Changelog link. | ||
| # Pure path-based filtering: a PR that edits a root-level file (e.g. Makefile) | ||
| # counts as a "core" change even if its intent was another module. | ||
| # | ||
| # Requires: gh (authenticated via GH_TOKEN), git (full history + tags), jq. | ||
| set -euo pipefail | ||
|
|
||
| cur="$1"; glob="$2"; key="$3" | ||
| repo="${GITHUB_REPOSITORY:?GITHUB_REPOSITORY not set}" | ||
|
|
||
| # Previous tag of the same module (newest tag matching the glob that isn't cur). | ||
| prev="$(git tag --list "$glob" --sort=-version:refname | grep -vFx "$cur" | head -n1 || true)" | ||
|
|
||
| # Raw GitHub-generated notes for the module's commit range. | ||
| if [ -n "$prev" ]; then | ||
| raw="$(gh api "repos/$repo/releases/generate-notes" \ | ||
| -f tag_name="$cur" -f previous_tag_name="$prev" --jq '.body')" | ||
| else | ||
| raw="$(gh api "repos/$repo/releases/generate-notes" -f tag_name="$cur" --jq '.body')" | ||
| fi | ||
|
|
||
| # Returns 0 if the file list on stdin contains a file belonging to $key. | ||
| module_match() { | ||
| case "$key" in | ||
| sdk) grep -qE '^sdk/' ;; | ||
| admin) grep -qE '^admin/' ;; | ||
| contrib) grep -E '^plugins/contrib/' | grep -qvE '^plugins/contrib/microsoft/keyvault/' ;; | ||
| # Exclude only the sibling modules (separate go.mod). plugins/reference has | ||
| # no go.mod, so it belongs to the root module and must count as core. | ||
| core) grep -qvE '^(sdk|plugins/contrib|admin|\.github|docs|\.ai)/' ;; | ||
| *) echo "unknown module key: $key" >&2; exit 2 ;; | ||
| esac | ||
| } | ||
|
|
||
| # Decide which PRs to keep (space-separated list of surviving PR numbers). | ||
| keepers="" | ||
| for pr in $(printf '%s\n' "$raw" | grep -oE 'pull/[0-9]+' | sed 's#pull/##' | sort -un); do | ||
| if gh api "repos/$repo/pulls/$pr/files" --paginate --jq '.[].filename' | module_match; then | ||
| keepers="$keepers $pr" | ||
| fi | ||
| done | ||
|
|
||
| # Re-emit the raw notes, dropping bullet lines whose PR wasn't kept, and | ||
| # dropping the "New Contributors" header if nothing survives under it. | ||
| printf '%s\n' "$raw" | awk -v keepers="$keepers" ' | ||
| BEGIN { split(keepers, a, " "); for (i in a) ok[a[i]] = 1 } | ||
| # Capture a section header; buffer until we know it has content. | ||
| /^## / { flush(); header = $0; have = 0; next } | ||
| # A bullet referencing a PR: keep only if that PR survived. | ||
| /pull\/[0-9]+/ { | ||
| n = $0; sub(/.*pull\//, "", n); sub(/[^0-9].*/, "", n) | ||
| if (ok[n]) { buffer = buffer (buffer ? "\n" : "") $0; have = 1 } | ||
| next | ||
| } | ||
| # Full Changelog (and any other prose) — pass through, flushing first. | ||
| { flush(); print } | ||
| END { flush() } | ||
| function flush() { | ||
| if (header != "") { | ||
| if (have) { print header; print buffer } | ||
| header = ""; buffer = ""; have = 0 | ||
| } else if (buffer != "") { print buffer; buffer = "" } | ||
| } | ||
| ' | cat -s | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Info] A transient PRs-API failure silently drops a PR from the notes
In the keepers loop,
if gh api ".../pulls/$pr/files" ... | module_matchruns underset -o pipefailinside anif. If the API call fails transiently (rate limit, 5xx), the condition evaluates false and the PR is silently excluded from the release notes instead of surfacing an error. Low impact since releases are created as drafts and reviewed by hand, but worth knowing.Optional hardening: capture the file list into a variable first and fail loudly (or retry) on a non-zero
gh apiexit, so an API hiccup can't quietly shrink the changelog.