docs.yml

name: Build Website

on:
  push:
    branches:
    - main
  pull_request:
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      -
        name: Set up Git repository
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
      -
        name: Install system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y \
            libcairo2-dev \
            libpango1.0-dev \
            libfreetype6-dev \
            libffi-dev \
            libjpeg-dev \
            libpng-dev \
            zlib1g-dev \
            graphviz \
            libgraphviz-dev
      -
        name: Install Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.14'
      -
        name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true
          cache-dependency-glob: "uv.lock"
      -
        name: Install all MkDocs dependencies
        run: make --environment-overrides docs-install-github-actions
      -
        name: Install Playwright browsers
        run: uv run playwright install chromium --with-deps
      -
        name: Build Site
        # Build runs on all branches and PRs to validate changes
        # run 'docs-build' twice because 'gen_files' doesn't let MkDocs
        # pick up on the generated files in the first run
        run: |
          make --environment-overrides docs-build
          make --environment-overrides docs-build
      -
        name: Deploy Site
        # Deploy only runs on main branch after successful build
        if: ${{ github.ref == 'refs/heads/main' }}
        run: make --environment-overrides docs-deploy