docs.yml

name: Deploy Docs

# Builds the MkDocs Material site from docs/, spec/, README.md, and
# CHANGELOG.md, then publishes to GitHub Pages. Runs on every push to
# main and on manual dispatch.

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'spec/**'
      - 'README.md'
      - 'CHANGELOG.md'
      - 'mkdocs.yml'
      - 'scripts/build-docs-site.sh'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

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

jobs:
  build-and-deploy:
    name: Build & deploy MkDocs site
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Install MkDocs Material
        run: pip install 'mkdocs==1.6.*' 'mkdocs-material==9.5.*' 'pymdown-extensions==10.*'
      - name: Populate docs-site/
        run: bash scripts/build-docs-site.sh
      - name: Build site
        run: mkdocs build --clean
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: site/
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4