automate including changelog content in release workflow (#368)

GitOrigin-RevId: 81ea71f266b5cbf42b6de5aa8759a46f9d790c0c

Author: blue-keleher

.github/workflows/release.yaml

@@ -30,10 +30,23 @@ jobs:
         with:
           gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.PASSPHRASE }}
+      - name: Extract release notes from CHANGELOG.md
+        id: release_notes
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          if bin/extract-release-notes.sh "$VERSION" CHANGELOG.md > release-notes.md; then
+            printf '\n---\n**Full Changelog:** [CHANGELOG.md](https://github.com/${{ github.repository }}/blob/main/CHANGELOG.md)\n' >> release-notes.md
+            echo "found=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "::warning::No CHANGELOG.md entry found for ${VERSION}. Release will be created without notes."
+            echo "found=false" >> "$GITHUB_OUTPUT"
+          fi
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@5742e2a039330cbb23ebf35f046f814d4c6ff811 # v5.1.0
         with:
-          args: release --clean
+          args: >-
+            release --clean
+            ${{ steps.release_notes.outputs.found == 'true' && '--release-notes=release-notes.md' || '' }}
         env:
           # GitHub sets the GITHUB_TOKEN secret automatically.
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.goreleaser.yml

@@ -31,6 +31,10 @@ archives:
 checksum:
   name_template: '{{ .ProjectName }}_{{ .Version }}_SHA256SUMS'
   algorithm: sha256
+release:
+  name_template: "v{{ .Version }}"
+changelog:
+  disable: true
 signs:
   - artifacts: checksum
     args:

bin/extract-release-notes.sh

@@ -0,0 +1,43 @@
+#!/bin/sh
+# Extracts the release notes for a given version from CHANGELOG.md.
+# Usage: bin/extract-release-notes.sh <version> <changelog-file>
+# Example: bin/extract-release-notes.sh 2.15.0 CHANGELOG.md
+#
+# Prints the extracted notes to stdout. Exits non-zero if no entry is found.
+
+set -e
+
+VERSION="${1:?Usage: extract-release-notes.sh <version> <changelog-file>}"
+CHANGELOG="${2:?Usage: extract-release-notes.sh <version> <changelog-file>}"
+
+if [ ! -f "$CHANGELOG" ]; then
+  echo "Error: file not found: $CHANGELOG" >&2
+  exit 1
+fi
+
+# Escape dots for regex (2.15.0 -> 2\.15\.0)
+VERSION_RE=$(echo "$VERSION" | sed 's/\./\\./g')
+
+# Extract content between this version's heading and the next ## heading,
+# stripping leading and trailing blank lines.
+NOTES=$(awk "
+  /^## \\[${VERSION_RE}\\]/ { found=1; next }
+  /^## \\[/ { if (found) exit }
+  found { lines[++n] = \$0 }
+  END {
+    # Trim leading blank lines
+    start = 1
+    while (start <= n && lines[start] ~ /^[[:space:]]*$/) start++
+    # Trim trailing blank lines
+    end = n
+    while (end >= start && lines[end] ~ /^[[:space:]]*$/) end--
+    for (i = start; i <= end; i++) print lines[i]
+  }
+" "$CHANGELOG")
+
+if [ -z "$(echo "$NOTES" | tr -d '[:space:]')" ]; then
+  echo "Error: no CHANGELOG.md entry found for version ${VERSION}" >&2
+  exit 1
+fi
+
+printf '%s\n' "$NOTES"

bin/extract-release-notes_test.sh

@@ -0,0 +1,114 @@
+#!/bin/sh
+# Tests for bin/extract-release-notes.sh
+set -e
+
+SCRIPT="$(dirname "$0")/extract-release-notes.sh"
+PASS=0
+FAIL=0
+
+assert_eq() {
+  test_name="$1"
+  expected="$2"
+  actual="$3"
+  if [ "$expected" = "$actual" ]; then
+    PASS=$((PASS + 1))
+  else
+    FAIL=$((FAIL + 1))
+    echo "FAIL: $test_name" >&2
+    echo "  expected: $(echo "$expected" | head -3)" >&2
+    echo "  actual:   $(echo "$actual" | head -3)" >&2
+  fi
+}
+
+assert_fails() {
+  test_name="$1"
+  shift
+  if "$@" > /dev/null 2>&1; then
+    FAIL=$((FAIL + 1))
+    echo "FAIL: $test_name (expected non-zero exit)" >&2
+  else
+    PASS=$((PASS + 1))
+  fi
+}
+
+TMPDIR=$(mktemp -d)
+trap 'rm -rf "$TMPDIR"' EXIT
+
+# --- Test: extracts correct version section ---
+cat > "$TMPDIR/changelog.md" << 'EOF'
+# Changelog
+
+## [2.15.0] - 2026-03-23
+
+### Added
+
+- Feature A
+- Feature B
+
+### Fixed
+
+- Bug fix C
+
+## [2.14.0] - 2026-03-13
+
+### Added
+
+- Feature D
+EOF
+
+RESULT=$(sh "$SCRIPT" "2.15.0" "$TMPDIR/changelog.md")
+assert_eq "extracts correct version" "### Added
+
+- Feature A
+- Feature B
+
+### Fixed
+
+- Bug fix C
+" "$RESULT
+"
+
+# --- Test: extracts last version (no trailing heading) ---
+RESULT=$(sh "$SCRIPT" "2.14.0" "$TMPDIR/changelog.md")
+assert_eq "extracts last version" "### Added
+
+- Feature D" "$RESULT"
+
+# --- Test: fails on missing version ---
+assert_fails "missing version exits non-zero" sh "$SCRIPT" "9.9.9" "$TMPDIR/changelog.md"
+
+# --- Test: fails on empty changelog ---
+cat > "$TMPDIR/empty.md" << 'EOF'
+# Changelog
+EOF
+assert_fails "empty changelog exits non-zero" sh "$SCRIPT" "1.0.0" "$TMPDIR/empty.md"
+
+# --- Test: fails on missing file ---
+assert_fails "missing file exits non-zero" sh "$SCRIPT" "1.0.0" "$TMPDIR/nonexistent.md"
+
+# --- Test: dots are literal, not regex wildcards ---
+cat > "$TMPDIR/tricky.md" << 'EOF'
+## [2X15Y0] - 2026-01-01
+
+### Added
+
+- Should not match
+
+## [2.15.0] - 2026-03-23
+
+### Added
+
+- Correct match
+EOF
+
+RESULT=$(sh "$SCRIPT" "2.15.0" "$TMPDIR/tricky.md")
+assert_eq "dots are literal" "### Added
+
+- Correct match" "$RESULT"
+
+# --- Test: no args ---
+assert_fails "no args exits non-zero" sh "$SCRIPT"
+
+# --- Summary ---
+echo "${PASS} passed, ${FAIL} failed"
+[ "$FAIL" -eq 0 ]