Merge pull request #974 from aireilly/mkdocs

fix CI

Author: aireilly

.github/workflows/publish-gh-pages.yml

@@ -1,32 +1,15 @@
-name: Deploy MkDocs to GitHub Pages
-
+name: Publish docs
 on:
   push:
-    branches: [ main ]
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: true
-
+    branches:
+      - main
 jobs:
-  build:
+  publication-builder:
+    name: Build and publish to publication branch
     runs-on: ubuntu-latest
-
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
-          cache: "pip"
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up Ruby (for Asciidoctor CLI)
         uses: ruby/setup-ruby@v1
@@ -35,26 +18,25 @@ jobs:
           bundler-cache: false
 
       - name: Install Asciidoctor + Rouge
-        run: sudo gem install --no-document asciidoctor rouge
+        run: gem install --no-document asciidoctor rouge
 
-      - name: Install MkDocs Python dependencies
-        run: pip install -r requirements.txt
+      - name: Install Python deps
+        run: |
+          python -m pip install -U pip
+          pip install mkdocs mkdocs-material mkdocs-callouts mkdocs-asciidoctor-backend
 
       - name: Build MkDocs site
         run: |
           python -m mkdocs build -f mkdocs.yml
 
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+      - name: Upload artifacts
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
         with:
           path: public
-
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deploy.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - id: deploy
-        uses: actions/deploy-pages@v4
+      - name: Commit artifact to publication branch
+        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
+        with:
+          force_orphan: true # publish branch with only the latest commit
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: publication
+          publish_dir: public

scripts/build-mkdocs-site.sh tools/build-mkdocs-site.shscripts/build-mkdocs-site.sh renamed to tools/build-mkdocs-site.sh

@@ -22,7 +22,7 @@ serve_site() {
 
 sync_sources
 
-# Build in GitLab CI, otherwise serve locally
+# Build in CI, otherwise serve locally
 case "${1:-}" in
   --build) build_site ;;
   *)