feat: extract release notes from CHANGELOG for GitHub releases

Author: Tranthanh98

.github/workflows/release-app-update.yml

@@ -123,6 +123,14 @@ jobs:
       - name: Verify DMG
         run: scripts/release/verify-dmg.sh "$DMG_PATH"
 
+      - name: Extract release notes from CHANGELOG
+        id: release_notes
+        run: |
+          RELEASE_NOTES=$(scripts/release/extract-release-notes.sh "$TAG_VERSION" CHANGELOG.md)
+          # Escape for use in gh release create --notes-file
+          printf '%s' "$RELEASE_NOTES" > "$RUNNER_TEMP/release-notes.md"
+          echo "release_notes_path=$RUNNER_TEMP/release-notes.md" >> "$GITHUB_OUTPUT"
+
       - name: Create stable GitHub Release
         id: create_release
         env:
@@ -132,11 +140,14 @@ jobs:
             gh release upload "$GITHUB_REF_NAME" "$ZIP_PATH" "$DMG_PATH" \
               --repo "$GITHUB_REPOSITORY" \
               --clobber
+            gh release edit "$GITHUB_REF_NAME" \
+              --repo "$GITHUB_REPOSITORY" \
+              --notes-file "${{ steps.release_notes.outputs.release_notes_path }}"
           else
             gh release create "$GITHUB_REF_NAME" "$ZIP_PATH" "$DMG_PATH" \
               --repo "$GITHUB_REPOSITORY" \
               --title "$GITHUB_REF_NAME" \
-              --generate-notes
+              --notes-file "${{ steps.release_notes.outputs.release_notes_path }}"
           fi
 
           gh release edit "$GITHUB_REF_NAME" \

scripts/release/extract-release-notes.sh

@@ -0,0 +1,47 @@
+#!/bin/zsh
+set -euo pipefail
+
+# Extract release notes from CHANGELOG.md for a given version.
+# Usage: ./scripts/release/extract-release-notes.sh <version> <changelog-path>
+# Example: ./scripts/release/extract-release-notes.sh 1.1.7 CHANGELOG.md
+
+VERSION="${1:?usage: extract-release-notes.sh <version> <changelog-path>}"
+CHANGELOG="${2:?usage: extract-release-notes.sh <version> <changelog-path>}"
+
+if [[ ! -f "$CHANGELOG" ]]; then
+  echo "Changelog not found: $CHANGELOG" >&2
+  exit 1
+fi
+
+# Read the changelog and extract the section for the given version
+# The format is:
+# ## v1.1.7
+# 
+# Changes since `v1.1.6`.
+# 
+# ### Added
+# ...
+# [Compare v1.1.6 to v1.1.7](...)
+
+# Use awk to extract the section for the given version
+# Start at "## v$VERSION" and stop at the next "## v" or end of file
+RELEASE_NOTES=$(awk -v version="v$VERSION" '
+  BEGIN { found = 0 }
+  /^## / {
+    if (found && $0 ~ "^## v") {
+      exit
+    }
+    if ($0 == "## " version) {
+      found = 1
+      next
+    }
+  }
+  found { print }
+' "$CHANGELOG")
+
+if [[ -z "$RELEASE_NOTES" ]]; then
+  echo "No release notes found for version v$VERSION in $CHANGELOG" >&2
+  exit 1
+fi
+
+printf '%s' "$RELEASE_NOTES"