Open PR instead of adding commit

Author: dbrattli

.github/workflows/readme-sync.yml

@@ -2,11 +2,13 @@ name: README Sync
 
 on:
   push:
+    paths:
+      - 'README.py'
 
 jobs:
-  sync-readme:
+  create-readme-pr:
     runs-on: ubuntu-latest
-    if: ${{ !contains(github.event.head_commit.message, '[auto] Sync README.md') }}
+    if: ${{ github.actor != 'github-actions[bot]' }}
 
     steps:
       - uses: actions/checkout@v4
@@ -23,36 +25,30 @@ jobs:
           pipx install poetry
           poetry install --all-extras
 
-      - name: Check for README changes
-        id: check_changes
+      - name: Create branch and update README
         run: |
-          # Get the list of changed files in the last commit
-          CHANGED_FILES=$(git diff --name-only HEAD^)
+          # Create new branch
+          git checkout -b readme-sync-${{ github.sha }}
 
-          # Check if README.md was modified
-          if echo "$CHANGED_FILES" | grep -q "README.md"; then
-            echo "Error: README.md was modified directly. This file is auto-generated from README.py. Please modify README.py instead."
-            exit 1
-          fi
-
-          # Check if README.py was modified
-          if echo "$CHANGED_FILES" | grep -q "README.py"; then
-            echo "readme_py_changed=true" >> $GITHUB_OUTPUT
-          else
-            echo "readme_py_changed=false" >> $GITHUB_OUTPUT
-          fi
-
-      - name: Update README.md from README.py
-        if: steps.check_changes.outputs.readme_py_changed == 'true'
-        run: |
-          # Run make_readme.sh to update README.md from README.py
+          # Generate new README.md
           poetry run ./make_readme.sh
 
-          # Commit and push if there are changes
+          # Setup git
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
+          # Commit changes if README.md was modified
           if ! git diff --quiet README.md; then
-            git config --local user.email "github-actions[bot]@users.noreply.github.com"
-            git config --local user.name "github-actions[bot]"
             git add README.md
             git commit -m "[auto] Sync README.md"
-            git push
+            git push origin readme-sync-${{ github.sha }}
           fi
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          title: '[auto] Sync README.md from README.py'
+          body: 'Auto-generated PR to sync README.md with changes from README.py'
+          branch: readme-sync-${{ github.sha }}
+          base: ${{ github.ref }}
+          labels: automated,documentation