Fix update-readme workflow for protected main branch (#174)

* Fix update-readme workflow for protected main branch

- Only push changes on pull_request events (where github.head_ref exists)
- Fail with helpful message if README is out of date on main push

* Update README.md

Author: basnijholt

.github/workflows/update-readme.yml

@@ -40,8 +40,14 @@ jobs:
           fi
 
       - name: Push changes
-        if: env.commit_status == 'committed'
+        if: env.commit_status == 'committed' && github.event_name == 'pull_request'
         uses: ad-m/github-push-action@master
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: ${{ github.head_ref }}
+
+      - name: Fail if README is out of date on main
+        if: env.commit_status == 'committed' && github.event_name == 'push'
+        run: |
+          echo "README.md is out of date. Please run 'uvx --with . markdown-code-runner README.md' and commit the changes."
+          exit 1

README.md

@@ -99,8 +99,9 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  -p, --port PORT       SSH port.
-  -i, --id_rsa ID_RSA   Specify the private ssh key to use.
+  -p PORT, --port PORT  SSH port.
+  -i ID_RSA, --id_rsa ID_RSA
+                        Specify the private ssh key to use.
   --rsync-get-flags     Display the default rsync flags that are used for
                         backup. If using remote drive over SSH, --compress
                         will be added.