ci: generate release notes for rc releases from conventional commits (#546)

Author: JeanPhilippeKernel

.github/workflows/release-please-prerelease.yml

@@ -15,13 +15,14 @@ jobs:
         outputs:
             new_version: ${{ steps.bump.outputs.new_version }}
             skipped: ${{ steps.bump.outputs.skipped }}
+            last_tag: ${{ steps.bump.outputs.last_tag }}
         steps:
             - uses: actions/checkout@v4
               with:
                   fetch-depth: 0
                   token: ${{ secrets.GITHUB_TOKEN }}
 
-            - name: Compute and write next rc version
+            - name: Compute next rc version
               id: bump
               run: |
                   set +e
@@ -33,17 +34,38 @@ jobs:
                       echo "skipped=true" >> "$GITHUB_OUTPUT"
                       exit 0
                   fi
+                  LAST_TAG="$(git describe --tags --abbrev=0 2>/dev/null || echo "")"
                   echo "new_version=$NEW_VERSION" >> "$GITHUB_OUTPUT"
+                  echo "last_tag=$LAST_TAG" >> "$GITHUB_OUTPUT"
                   echo "skipped=false" >> "$GITHUB_OUTPUT"
 
+            - name: Generate release notes
+              id: notes
+              if: steps.bump.outputs.skipped != 'true'
+              run: |
+                  NOTES="$(bash Scripts/generate-changelog.sh \
+                      "${{ steps.bump.outputs.last_tag }}" \
+                      HEAD \
+                      "${{ steps.bump.outputs.new_version }}")"
+                  # Write to file to safely pass multiline content
+                  echo "$NOTES" > /tmp/release-notes.md
+                  echo "notes_file=/tmp/release-notes.md" >> "$GITHUB_OUTPUT"
+
             - name: Tag
               if: steps.bump.outputs.skipped != 'true'
               run: |
                   git config user.name  "github-actions[bot]"
                   git config user.email "github-actions[bot]@users.noreply.github.com"
-                  git tag "v${{ steps.bump.outputs.new_version }}"
+                  git tag -a "v${{ steps.bump.outputs.new_version }}" -m "chore: release ${{ steps.bump.outputs.new_version }}"
                   git push origin "v${{ steps.bump.outputs.new_version }}"
 
+            - name: Upload release notes
+              if: steps.bump.outputs.skipped != 'true'
+              uses: actions/upload-artifact@v6
+              with:
+                  name: release-notes
+                  path: /tmp/release-notes.md
+
     publish-windows:
         needs: bump-version
         if: ${{ needs.bump-version.outputs.skipped != 'true' }}
@@ -87,4 +109,5 @@ jobs:
                   name: ${{ needs.bump-version.outputs.new_version }}
                   prerelease: true
                   generate_release_notes: false
+                  body_path: artifacts/release-notes/release-notes.md
                   files: artifacts/**/*

Scripts/generate-changelog.sh

@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+# Generates a markdown changelog from conventional commits between two refs.
+#
+# Usage: generate-changelog.sh <from-ref> <to-ref> <version>
+# Output: markdown string printed to stdout
+
+set -euo pipefail
+
+FROM_REF="${1:-}"
+TO_REF="${2:-HEAD}"
+VERSION="${3:-unreleased}"
+
+if [ -z "$FROM_REF" ]; then
+    COMMIT_RANGE="$TO_REF"
+else
+    COMMIT_RANGE="$FROM_REF..$TO_REF"
+fi
+
+declare -a BREAKING=()
+declare -a FEATURES=()
+declare -a FIXES=()
+declare -a PERF=()
+declare -a REFACTORS=()
+declare -a OTHER=()
+
+while IFS= read -r line; do
+    [ -z "$line" ] && continue
+
+    if echo "$line" | grep -qE '^(feat|fix|perf|refactor|build|ci|revert)(\(.+\))?!:' || \
+       echo "$line" | grep -qE 'BREAKING CHANGE:'; then
+        BREAKING+=("$line")
+    elif echo "$line" | grep -qE '^feat(\(.+\))?:'; then
+        FEATURES+=("$line")
+    elif echo "$line" | grep -qE '^fix(\(.+\))?:'; then
+        FIXES+=("$line")
+    elif echo "$line" | grep -qE '^perf(\(.+\))?:'; then
+        PERF+=("$line")
+    elif echo "$line" | grep -qE '^refactor(\(.+\))?:'; then
+        REFACTORS+=("$line")
+    fi
+done < <(git log "$COMMIT_RANGE" --format="%s" 2>/dev/null)
+
+echo "## $VERSION"
+echo ""
+echo "$(date -u +%Y-%m-%d)"
+echo ""
+
+if [ ${#BREAKING[@]} -gt 0 ]; then
+    echo "### ⚠ Breaking Changes"
+    echo ""
+    for entry in "${BREAKING[@]}"; do echo "* $entry"; done
+    echo ""
+fi
+
+if [ ${#FEATURES[@]} -gt 0 ]; then
+    echo "### Features"
+    echo ""
+    for entry in "${FEATURES[@]}"; do echo "* $entry"; done
+    echo ""
+fi
+
+if [ ${#FIXES[@]} -gt 0 ]; then
+    echo "### Bug Fixes"
+    echo ""
+    for entry in "${FIXES[@]}"; do echo "* $entry"; done
+    echo ""
+fi
+
+if [ ${#PERF[@]} -gt 0 ]; then
+    echo "### Performance"
+    echo ""
+    for entry in "${PERF[@]}"; do echo "* $entry"; done
+    echo ""
+fi
+
+if [ ${#REFACTORS[@]} -gt 0 ]; then
+    echo "### Refactors"
+    echo ""
+    for entry in "${REFACTORS[@]}"; do echo "* $entry"; done
+    echo ""
+fi