ci: optimize git-cliff workflow for automated changelog (#117)

Co-authored-by: Claude <noreply@anthropic.com>

Author: JacobCoffee

.github/workflows/cd.yml

@@ -15,38 +15,41 @@ jobs:
     runs-on: ubuntu-22.04
     permissions:
       contents: write
+      pull-requests: write
     outputs:
-      release_body: ${{ steps.git-cliff.outputs.content }}
+      release_body: ${{ steps.git-cliff-latest.outputs.content }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Generate a changelog
-        uses: orhun/git-cliff-action@main
-        id: git-cliff
+      - name: Generate latest changelog for release
+        uses: orhun/git-cliff-action@v4
+        id: git-cliff-latest
         with:
           config: pyproject.toml
           args: -vv --latest --strip header
+        env:
+          GITHUB_REPO: ${{ github.repository }}
 
       - name: Fetch latest main
         run: git fetch origin main
 
       - name: Create worktree for changelog
         run: git worktree add worktree-changelog origin/main
 
-      - name: Install git-cliff
-        uses: taiki-e/install-action@v2
+      - name: Generate full changelog in worktree
+        working-directory: worktree-changelog
+        uses: orhun/git-cliff-action@v4
         with:
-          tool: git-cliff
-
-      - name: Generate changelog in worktree
-        run: |
-          cd worktree-changelog
-          git-cliff --config ../pyproject.toml -vv --latest --strip header --output docs/changelog.rst
+          config: pyproject.toml
+          args: -vv
+        env:
+          OUTPUT: docs/changelog.rst
+          GITHUB_REPO: ${{ github.repository }}
 
-      - name: Commit and push changelog
+      - name: Create PR with changelog updates
         working-directory: worktree-changelog
         run: |
           git config user.name 'github-actions[bot]'
@@ -55,9 +58,37 @@ jobs:
           if git diff --staged --quiet; then
             echo "No changes to commit"
           else
-            git commit -m "docs: update changelog [skip ci]"
-            git push origin HEAD:main
+            # Create unique branch name (includes run ID to avoid collisions on reruns)
+            BRANCH_NAME="changelog/update-$(git rev-parse --short HEAD)-${{ github.run_id }}"
+            git checkout -b "$BRANCH_NAME"
+
+            git commit -m "docs: update changelog"
+
+            # Push and create PR
+            git push origin "$BRANCH_NAME"
+            gh pr create \
+              --base main \
+              --head "$BRANCH_NAME" \
+              --title "docs: update changelog" \
+              --body "Automated changelog update generated by git-cliff.
+
+          This PR updates the changelog with the latest commits.
+
+              --label "documentation" \
+              --label "automated"
           fi
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Update GitHub release body
+        if: github.event_name == 'release'
+        run: |
+          # Update release body with latest changelog
+          gh release edit "${{ github.event.release.tag_name }}" \
+            --notes "${{ steps.git-cliff-latest.outputs.content }}" \
+            --repo ${{ github.repository }}
+        env:
+          GH_TOKEN: ${{ github.token }}
 
       - name: Cleanup worktree
         if: always()

.pre-commit-config.yaml

@@ -23,12 +23,6 @@ repos:
       - id: ruff-check
         args: ["--fix"]
       - id: ruff-format
-  - repo: https://github.com/sourcery-ai/sourcery
-    rev: v1.40.0
-    hooks:
-      - id: sourcery
-        args: [--diff=git diff HEAD, --no-summary]
-        stages: [commit]
   - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1
     hooks:

pyproject.toml

@@ -269,6 +269,7 @@ known-first-party = ["byte_common", "byte_api", "tests"]
 ]
 
 [tool.git-cliff.changelog]
+output = "docs/changelog.rst"
 header = """
 =========
 Changelog