workspace-grouped changelog, no more git-cliff!

Author: paulbalaji

.github/workflows/rust-release.yml

@@ -110,10 +110,6 @@ jobs:
         with:
           fetch-depth: 0
       - uses: dtolnay/rust-toolchain@stable
-      - name: Install git-cliff
-        uses: taiki-e/install-action@v2
-        with:
-          tool: git-cliff
       - name: Determine next version from conventional commits
         id: next_version
         working-directory: ./rust/main
@@ -178,17 +174,16 @@ jobs:
           echo "Next version: $NEW_VERSION ($BUMP_TYPE bump from $CURRENT_VERSION)"
       - name: Generate changelog
         id: changelog
-        working-directory: ./rust/main
         env:
           NEW_VERSION: ${{ steps.next_version.outputs.new_version }}
         run: |
-          # Generate changelog for commits since last release
+          # Generate workspace-grouped changelog using custom script
           LATEST_TAG=$(git tag -l "agents-v*" --sort=-version:refname | grep -E "^agents-v[0-9]+\.[0-9]+\.[0-9]+$" | head -1)
 
           if [ -z "$LATEST_TAG" ]; then
-            CHANGELOG=$(git-cliff --config cliff.toml --unreleased --strip all)
+            CHANGELOG=$(./rust/scripts/generate-workspace-changelog.sh)
           else
-            CHANGELOG=$(git-cliff --config cliff.toml "${LATEST_TAG}..HEAD" --strip all)
+            CHANGELOG=$(./rust/scripts/generate-workspace-changelog.sh "${LATEST_TAG}..HEAD")
           fi
 
           # Save changelog to file for PR body
@@ -276,11 +271,11 @@ jobs:
           git push -f origin "$BRANCH_NAME"
 
           # Create or update PR
-          PR_BODY="## Release agents v${NEW_VERSION}
+          PR_BODY="# Release agents v${NEW_VERSION}
 
           This PR prepares the release of Hyperlane agents version **${NEW_VERSION}** (${BUMP_TYPE} bump).
 
-          ### What's Changed
+          ## What's Changed
 
           ${CHANGELOG}
 
@@ -335,12 +330,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Install git-cliff
-        uses: taiki-e/install-action@v2
-        with:
-          tool: git-cliff
       - name: Determine version and create release
-        working-directory: ./rust/main
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           IS_PRERELEASE: ${{ github.event_name == 'workflow_dispatch' && inputs.prerelease }}
@@ -380,12 +370,21 @@ jobs:
           TAG_NAME="agents-v${VERSION}"
           echo "Creating $RELEASE_TYPE: $TAG_NAME"
 
-          # Generate changelog
+          # Generate workspace-grouped changelog
           PREV_TAG=$(git describe --tags --abbrev=0 --match "agents-v*" 2>/dev/null || echo "")
+
+          # For stable releases (push to main), use HEAD~1 to exclude the version bump commit
+          # For prereleases (workflow_dispatch), use HEAD since there's no version bump commit
+          if [ "$IS_PRERELEASE" = "true" ]; then
+            COMMIT_RANGE_END="HEAD"
+          else
+            COMMIT_RANGE_END="HEAD~1"
+          fi
+
           if [ -z "$PREV_TAG" ]; then
-            CHANGELOG=$(git-cliff --config cliff.toml --unreleased --strip all)
+            CHANGELOG=$(./rust/scripts/generate-workspace-changelog.sh)
           else
-            CHANGELOG=$(git-cliff --config cliff.toml --latest --strip all)
+            CHANGELOG=$(./rust/scripts/generate-workspace-changelog.sh "${PREV_TAG}..${COMMIT_RANGE_END}")
           fi
 
           # Add warning for pre-releases

rust/main/cliff.toml

@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+# Script to generate workspace-grouped changelog for rust agents
+set -euo pipefail
+
+# Determine script directory and repo structure
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+RUST_MAIN_DIR="$SCRIPT_DIR/../main"
+
+# Get the commit range
+if [ $# -eq 0 ]; then
+    # No arguments - use unreleased commits
+    LATEST_TAG=$(git tag -l "agents-v*" --sort=-version:refname | grep -E "^agents-v[0-9]+\.[0-9]+\.[0-9]+$" | head -1 || echo "")
+    if [ -z "$LATEST_TAG" ]; then
+        COMMIT_RANGE="HEAD"
+    else
+        COMMIT_RANGE="${LATEST_TAG}..HEAD"
+    fi
+else
+    COMMIT_RANGE="$1"
+fi
+
+# Temporary directory for categorization
+TEMP_DIR=$(mktemp -d)
+trap "rm -rf $TEMP_DIR" EXIT
+
+# Extract workspace members from rust/main/Cargo.toml
+WORKSPACE_MEMBERS=$(grep -A 100 '^\[workspace\]' "$RUST_MAIN_DIR/Cargo.toml" | sed -n '/^members = \[/,/^\]/p' | grep '"' | sed 's/[", ]//g')
+
+# Get all commits in the range (filter to rust/main directory)
+git log --no-merges --format="%H" $COMMIT_RANGE -- rust/main | while read -r commit_hash; do
+    # Get commit message
+    commit_msg=$(git log -1 --format="%s" "$commit_hash")
+    short_hash=$(echo "$commit_hash" | cut -c1-7)
+
+    # Get files changed in this commit (within rust/main)
+    files=$(git diff-tree --no-commit-id --name-only -r "$commit_hash" -- rust/main)
+
+    # Categorize based on workspace membership
+    workspace=""
+    for file in $files; do
+        # Strip rust/main/ prefix if present
+        file=$(echo "$file" | sed 's|^rust/main/||')
+
+        # Check which workspace this file belongs to
+        for member in $WORKSPACE_MEMBERS; do
+            if [[ "$file" =~ ^"$member"(/|$) ]]; then
+                workspace="$member"
+                break 2  # Break both loops
+            fi
+        done
+    done
+
+    # Default to "Other" if no workspace found
+    if [ -z "$workspace" ]; then
+        workspace="Other"
+    fi
+
+    # Sanitize workspace name for file system (replace / with __)
+    workspace_file=$(echo "$workspace" | tr '/' '_')
+
+    # Store commit in workspace category file
+    echo "$workspace|$commit_msg|$short_hash" >> "$TEMP_DIR/$workspace_file"
+done
+
+# Process workspace members in the order they appear in Cargo.toml, then "Other"
+for workspace in $WORKSPACE_MEMBERS "Other"; do
+    workspace_file=$(echo "$workspace" | tr '/' '_')
+
+    if [ -f "$TEMP_DIR/$workspace_file" ]; then
+        echo "### $workspace"
+        echo ""
+
+        # Sort and deduplicate commits (extract workspace name, msg, hash)
+        sort -u "$TEMP_DIR/$workspace_file" | while IFS='|' read -r ws msg hash; do
+            echo "* $msg (#$hash)"
+        done
+        echo ""
+    fi
+done
+
+echo "<!-- generated by workspace changelog script -->"