deploy-documentation.yaml

name: Build and Deploy Docs to GitHub Pages
description: Test building docs on pull requests, only deploy when pushing to main.
on:
  pull_request:
  push:
    branches:
      - main

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  UV_VERSION: "0.7.x"

jobs:
  build-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@main
        with:
          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo

      - name: Set up Python 3
        uses: actions/setup-python@main
        with:
          python-version: "3.11"

      - name: Install uv
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: true
          version: ${{ env.UV_VERSION }}

      - name: Verify lockfile is up-to-date
        run: |
          uv lock --directory backend --check

      - name: Install Dependencies
        run: uv sync --directory backend --extra dev

      - name: Build Documentation
        run: make docs

      # Only deploy pages when pushing to main
      - name: Deploy to gh-pages
        uses: JamesIves/github-pages-deploy-action@v4
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        with:
          folder: site
          target-folder: docs
          clean: true