docs.yml

# ============================================================================
# Build the Weft Federation hub docs and deploy to GitHub Pages.
#
# Pages source must be set to "GitHub Actions" (Settings → Pages → Build and
# deployment → Source: GitHub Actions). This workflow runs the build-time
# mirror (scripts/build-docs.sh) then `mkdocs build --strict`, and publishes
# the generated site/ via actions/deploy-pages.
#
# Action versions are pinned. Authored for review — not auto-enabled here.
# ============================================================================
name: Docs

on:
  push:
    branches: [main]
  workflow_dispatch:

# Least-privilege; Pages deploy needs id-token + pages write.
permissions:
  contents: read
  pages: write
  id-token: write

# One in-flight Pages deploy at a time; don't cancel a running deploy.
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install MkDocs Material
        run: |
          python -m pip install --upgrade pip
          # Pin to the toolchain the site was verified against locally.
          pip install "mkdocs==1.6.1" "mkdocs-material==9.7.4"

      - name: Mirror root markdown into docs/
        run: |
          chmod +x scripts/build-docs.sh
          ./scripts/build-docs.sh

      - name: Build site (strict)
        run: mkdocs build --strict

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy:
    needs: build
    runs-on: ubuntu-24.04
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4