docs.yml

name: Documentation

# docs/site/docs/changelog.md is a symlink to the root CHANGELOG.md. Its own blob is
# just the constant link target, so regenerating the changelog changes no path under
# docs/site/** and would never rebuild the site. The root file has to be listed too.
on:
  push:
    branches: [main]
    paths:
      - "docs/site/**"
      - "CHANGELOG.md"
      - ".github/workflows/docs.yml"
  pull_request:
    branches: [main]
    paths:
      - "docs/site/**"
      - "CHANGELOG.md"
  # For rebuilding the site by hand. The release changelog commit doesn't need it:
  # it is pushed with the release App's token, so it triggers the push run above.
  workflow_dispatch:

permissions:
  contents: read

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

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: "3.12"

      - name: Install dependencies
        run: pip install --require-hashes -r docs/site/requirements.txt

      - name: Build documentation
        run: |
          cd docs/site
          mkdocs build --strict

      - name: Upload artifact
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with:
          path: docs/site/site

  deploy:
    # Deploy on push and on manual/dispatched runs, never from a pull request, and
    # only ever from main so a dispatch on a branch cannot publish that branch.
    if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    timeout-minutes: 10
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1