Add MkDocs GitHub Pages publish workflow

2026-05-13 08:25:31 +10:00
parent 0b67830d7f
commit 79c583eca3
6 changed files with 82 additions and 5 deletions
@@ -0,0 +1,70 @@
+name: Publish documentation site
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: github-pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install tooling
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y graphviz jq python3 python3-pip
+
+          if ! docker compose version >/dev/null 2>&1; then
+            sudo apt-get install -y docker-compose-v2 || sudo apt-get install -y docker-compose || true
+          fi
+
+          if ! docker compose version >/dev/null 2>&1; then
+            echo "docker compose CLI is unavailable on this runner" >&2
+            exit 1
+          fi
+
+          python3 -m pip install --user mkdocs pyyaml jinja2
+
+      - name: Generate documentation
+        run: |
+          chmod +x scripts/docs/*.sh
+          scripts/docs/generate-all.sh
+
+      - name: Build MkDocs site
+        run: |
+          python3 -m mkdocs build --strict
+
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload GitHub Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4