docs.yml

name: Deploy docs

# Publishes the MkDocs site to GitHub Pages (https://swgoh-utils.github.io/comlink-python/).
#
# Deploys from `main` only, so the published docs always describe the latest release
# rather than unreleased work on `develop`. CI's `docs` job still build-checks every PR.
#
# One-time setup: Settings -> Pages -> Build and deployment -> Source: "GitHub Actions".

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

permissions:
  contents: read

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

jobs:
  build:
    name: Build docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - name: Install uv
        uses: astral-sh/setup-uv@v7

      - name: Set up Python
        uses: actions/setup-python@v7
        with:
          python-version: "3.12"

      - name: Install dependencies
        run: uv sync --group docs

      - name: Build docs
        run: uv run mkdocs build --strict

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: site/

  deploy:
    name: Deploy to GitHub Pages
    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
        id: deployment
        uses: actions/deploy-pages@v5