docs.yml

# Build the mkdocs site on every push/PR; deploy to GitHub Pages when
# main is updated. Matches the pattern used by openvax/vaxrank.
#
# For the deploy to work, the repository's Pages source must be set to
# "GitHub Actions" under Settings → Pages. The build job runs on PRs
# so broken docs fail the check before merge.
name: Docs

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

# Cancel in-flight runs on the same ref when a newer push arrives.
concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          fetch-depth: 0   # mkdocs plugins can look at git history

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.11"
          cache: pip

      - name: Install varcode and docs dependencies
        run: |
          python -m pip install --upgrade pip
          # mkdocstrings needs varcode importable, but doesn't need
          # the Ensembl FASTA caches that the test workflow downloads.
          pip install -r requirements.txt
          pip install .
          pip install mkdocs mkdocs-material 'mkdocstrings[python]'

      - name: Build docs
        run: mkdocs build

      - name: Upload site artifact
        if: github.ref == 'refs/heads/main'
        uses: actions/upload-pages-artifact@v5.0.0
        with:
          path: site/

  deploy:
    needs: build
    if: github.ref == 'refs/heads/main'
    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