chore(ci): create PR for changelog updates instead of pushing to main

Author: akhundMurad

.github/workflows/publish.yaml

@@ -79,6 +79,7 @@ jobs:
     needs: [publish-package]
     permissions:
       contents: write
+      pull-requests: write
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -95,13 +96,33 @@ jobs:
       - name: Generate release notes
         run: git cliff --latest --strip header -o RELEASE_NOTES.md
 
-      - name: Commit changelog
+      - name: Commit changelog to branch
         run: |
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          BRANCH="changelog/${{ github.ref_name }}-${{ github.run_id }}"
+          git checkout -b "$BRANCH"
+
           git add CHANGELOG.md
-          git diff --staged --quiet || git commit -m "chore: update changelog for ${{ github.ref_name }}"
-          git push origin HEAD:main
+          if git diff --staged --quiet; then
+            echo "No changelog changes; skipping commit + PR."
+            exit 0
+          fi
+
+          git commit -m "chore: update changelog for ${{ github.ref_name }}"
+          git push origin "$BRANCH"
+
+      - name: Create pull request for changelog
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          base: main
+          branch: changelog/${{ github.ref_name }}-${{ github.run_id }}
+          title: "chore: update changelog for ${{ github.ref_name }}"
+          body: |
+            Automated changelog update for `${{ github.ref_name }}`.
+          commit-message: "chore: update changelog for ${{ github.ref_name }}"
 
       - name: Upload release notes
         uses: actions/upload-artifact@v4