docs.yml

name: Docs

# Manual only: click "Run workflow" to publish the docs on main.
on:
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    name: Build Docusaurus
    runs-on: ubuntu-latest
    steps:
      # Publishing is main-only. The github-pages environment enforces this at
      # deploy time, but fail loud here too so a mistaken dispatch from another
      # branch stops before building instead of silently producing no deploy.
      - name: Refuse to publish from a non-main branch
        if: github.ref != 'refs/heads/main'
        env:
          DISPATCHED_REF: ${{ github.ref }}
        run: |
          echo "::error::Docs publish only from main (dispatched ref: $DISPATCHED_REF)."
          exit 1
      - uses: actions/checkout@v6

      - uses: actions/setup-node@v4
        with:
          node-version: 24
          cache: npm
          cache-dependency-path: docs/package-lock.json

      - name: Install dependencies
        # npm ci = reproducible install from package-lock.json (npm install
        # re-resolves ranges at run time and can drift between runs)
        run: npm ci
        working-directory: ./docs

      - name: Build website
        run: npm run build
        working-directory: ./docs

      - name: Upload Build Artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/build

  deploy:
    name: Deploy to GitHub Pages
    needs: build

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4