New fix for README sync (#242)

Author: dbrattli

.github/workflows/readme-sync.yml

@@ -23,51 +23,36 @@ jobs:
           pipx install poetry
           poetry install --all-extras
 
-      - name: Check if README.md was modified directly
+      - name: Check for README changes
         id: check_changes
         run: |
           # Get the list of changed files in the last commit
           CHANGED_FILES=$(git diff --name-only HEAD^)
 
-          # Check if README.md was the only file changed
-          if [[ $(echo "$CHANGED_FILES" | grep -v "README.md" | wc -l) -eq 0 ]]; then
-            echo "readme_only_change=true" >> $GITHUB_OUTPUT
+          # 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_only_change=false" >> $GITHUB_OUTPUT
+            echo "readme_py_changed=false" >> $GITHUB_OUTPUT
           fi
 
-      - name: Convert README.md to README.py
-        if: steps.check_changes.outputs.readme_only_change == 'true'
+      - name: Update README.md from README.py
+        if: steps.check_changes.outputs.readme_py_changed == 'true'
         run: |
-          # Save current README.md
-          cp README.md README.md.orig
-
-          # Run make_readme.sh to get a clean README.md
+          # Run make_readme.sh to update README.md from README.py
           poetry run ./make_readme.sh
 
-          # Restore original README.md
-          mv README.md.orig README.md
-
-          # Check if there are differences in README.py
-          if ! git diff --quiet README.py; then
-            echo "changes_detected=true" >> $GITHUB_OUTPUT
-          else
-            echo "changes_detected=false" >> $GITHUB_OUTPUT
+          # Commit and push if there are changes
+          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
           fi
-
-      - name: Create Pull Request
-        if: steps.check_changes.outputs.readme_only_change == 'true' && steps.check_changes.outputs.changes_detected == 'true'
-        uses: peter-evans/create-pull-request@v5
-        with:
-          commit-message: "[auto] Sync README.md"
-          title: "docs: Sync README changes"
-          body: |
-            This PR was automatically created because README.md was edited directly.
-
-            In this project, we maintain README.md through README.py to ensure proper formatting and consistency.
-            Please make future edits to README.py instead of README.md.
-
-            This PR updates README.py to match the changes made to README.md.
-          branch: fix/readme-sync
-          delete-branch: true
-          labels: documentation