Add automated changelog generation with git-cliff

Introduces cliff.toml with custom commit parsers for the project's
verb-first commit style, and updates the release workflow to generate
CHANGELOG.md and use it for GitHub Release notes.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: KaboomFox

.github/workflows/release.yml

@@ -13,9 +13,48 @@ jobs:
     name: CI
     uses: ./.github/workflows/ci.yml
 
+  changelog:
+    name: Generate changelog
+    needs: ci
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    outputs:
+      release_body: ${{ steps.release_body.outputs.content }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
+
+      - name: Generate full changelog
+        uses: orhun/git-cliff-action@v4
+        with:
+          args: --tag ${{ github.ref_name }}
+        env:
+          OUTPUT: CHANGELOG.md
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Generate release body
+        id: release_body
+        uses: orhun/git-cliff-action@v4
+        with:
+          args: --latest --tag ${{ github.ref_name }} --strip header
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Commit changelog
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add CHANGELOG.md
+          git diff --staged --quiet && exit 0
+          git commit -m "Update CHANGELOG.md for ${{ github.ref_name }} [skip ci]"
+          git push origin main
+
   publish:
     name: Publish to crates.io
-    needs: ci
+    needs: changelog
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -30,14 +69,15 @@ jobs:
 
   github-release:
     name: GitHub Release
-    needs: publish
+    needs: [changelog, publish]
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
       - uses: actions/checkout@v4
 
       - name: Create GitHub Release
-        run: gh release create "${{ github.ref_name }}" --generate-notes
+        run: gh release create "${{ github.ref_name }}" --notes "$RELEASE_BODY"
         env:
           GH_TOKEN: ${{ github.token }}
+          RELEASE_BODY: ${{ needs.changelog.outputs.release_body }}

cliff.toml

@@ -0,0 +1,60 @@
+[changelog]
+header = """# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
+"""
+body = """
+{%- macro remote_url() -%}
+  https://github.com/KaboomFox/ws-shard-manager
+{%- endmacro -%}
+
+{% if version -%}
+## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else -%}
+## [Unreleased]
+{% endif -%}
+
+{% for group, commits in commits | group_by(attribute="group") %}
+### {{ group | striptags | trim }}
+{% for commit in commits %}
+- {{ commit.message | split(pat="\n") | first | trim }}
+{%- endfor %}
+{% endfor %}
+"""
+footer = """
+{%- macro remote_url() -%}
+  https://github.com/KaboomFox/ws-shard-manager
+{%- endmacro -%}
+
+{% for release in releases -%}
+{% if release.version -%}
+{% if release.previous.version -%}
+[{{ release.version | trim_start_matches(pat="v") }}]: {{ self::remote_url() }}/compare/{{ release.previous.version }}...{{ release.version }}
+{% else -%}
+[{{ release.version | trim_start_matches(pat="v") }}]: {{ self::remote_url() }}/releases/tag/{{ release.version }}
+{% endif -%}
+{% else -%}
+{% if release.previous.version -%}
+[Unreleased]: {{ self::remote_url() }}/compare/{{ release.previous.version }}...HEAD
+{% endif -%}
+{% endif -%}
+{% endfor %}
+"""
+trim = true
+
+[git]
+conventional_commits = false
+commit_parsers = [
+  { message = "^Bump version", skip = true },
+  { message = "^Add|^Initial|^Support", group = "Added" },
+  { message = "^Fix", group = "Fixed" },
+  { message = "^Document", group = "Documentation" },
+  { message = "^Remove", group = "Removed" },
+  { message = "^Sanitize", group = "Security" },
+  { message = "^Revert", group = "Reverted" },
+  { message = "^Improve|^Update|^Relax|^Reduce|^Refactor|^Major", group = "Changed" },
+  { message = ".*", group = "Changed" },
+]