# Builds the MkDocs documentation and publishes it to GitHub Pages using the
# native Pages flow (no gh-pages branch). Runs on every push to main that
# touches the docs.
#
# One-time repository setup: Settings → Pages → Source: "GitHub Actions".
name: docs

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

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

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.x"

      # Pinned to the version served by the local `docs` compose service
      # (squidfunk/mkdocs-material): keep the two in sync when upgrading.
      - run: pip install mkdocs-material==9.7.6

      - run: mkdocs build --strict

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

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