deploy_docs.yml

name: Build and Deploy Documentation

# mike commits each version of the site to the gh-pages branch, which GitHub Pages serves.
on:
  push:
    branches:
      - main
  release:
    types: [published]

permissions:
  contents: write

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Install uv
        uses: astral-sh/setup-uv@v5
        with:
          enable-cache: true

      - name: Set up Python
        run: uv python install

      - name: Install the project
        run: uv sync --all-extras --dev

      - name: Configure Git
        run: |
          git config user.name 'github-actions[bot]'
          git config user.email 'github-actions[bot]@users.noreply.github.com'

      # Rules added since the last release show "Unreleased" until their version is stamped in the
      # source; the released docs show the version they ship in.
      - name: Stamp unreleased rules
        if: github.event_name == 'release'
        env:
          VERSION: ${{ github.event.release.tag_name }}
        run: sed -i "s/\*\*Since\*\* \`Unreleased\`/**Since** \`$VERSION\`/" docs/reference/rules/*.md

      - name: Build and push the docs
        env:
          VERSION: ${{ github.event.release.tag_name }}
        run: |
          if [ "${{ github.event_name }}" = "release" ]; then
            uv run mike deploy --push --update-aliases "$VERSION" latest
            uv run mike set-default --push latest
          else
            uv run mike deploy --push main
          fi