Fix preview/postmerge doc publishing conflict. (#22)

* Fix preview/postmerge doc publishing conflict.

This removes the GHA to push to pages and instead just publishes the `gh-pages` branch to pages.  It also changes our doc publishing to work by just publishing to that branch.

* Only run publishing steps when docs change.

* Add some more lint/format checks. (#21)

* Add some more lint/format checks.

*  Add yamlfmt as a required check
*  Make it easier for people to run the checks locally

* yamlfmt all files.

* Fix workflow to be correct path.

* Fix yaml formatting

Author: billnapier

.github/workflows/publish_docs.yml

@@ -3,13 +3,16 @@ on:
   push:
     branches:
       - master
+    paths:
+      - '**.md'
+      - '.github/workflow/publish*'
   workflow_dispatch:
 permissions:
   pages: 'write'
   id-token: 'write'
 jobs:
-  build:
-    name: "Build Docs"
+  build-and-deploy:
+    name: "Build and Deploy Docs"
     runs-on: 'ubuntu-latest'
     steps:
       - uses: 'actions/checkout@v4'
@@ -18,18 +21,11 @@ jobs:
         with:
           src: 'docs'
           dst: 'generated-pages'
-      - name: 'Upload artifact'
-        uses: 'actions/upload-pages-artifact@v3'
+      - name: 'Install rsync'
+        run: 'apt-get update && apt-get install -y rsync'
+      - name: 'Deploy Docs'
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          path: 'generated-pages'
-  deploy:
-    name: "Deploy Docs"
-    environment:
-      name: 'github-pages'
-      url: '${{ steps.deployment.outputs.page_url }}'
-    runs-on: 'ubuntu-latest'
-    needs: 'build'
-    steps:
-      - name: 'Deploy to GitHub Pages'
-        id: 'deployment'
-        uses: 'actions/deploy-pages@v4'
+          folder: generated-pages
+          force: false
+          clean-exclude: pr-preview/