docs.yml

name: Docs

# Build the MkDocs site and publish it to GitHub Pages. Runs on pushes to main
# (the release branch) so the published docs track released code.
# One-time setup by a repository admin: Settings -> Pages -> Build and deployment
# -> Source: GitHub Actions.
on:
  push:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7.0.1
      - name: Install uv
        uses: astral-sh/setup-uv@v9.0.0
      - name: Build the docs site
        run: uv run --group docs mkdocs build --strict
      - name: Upload the site artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: site

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