deploy.yml

# Runs on pushes targeting the main branch
name: Deploy to GitHub Pages
on:
  push:
    branches: main
  workflow_dispatch:

env:
  # `BASE_URL` determines the website is served from, including CSS & JS assets
  # You may need to change this to `BASE_URL: ''`
  BASE_URL: /${{ github.event.repository.name }}

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest

    steps:
      # Configure environment
      - uses: actions/checkout@v5

      - name: Setup Pages
        uses: actions/configure-pages@v5

      # Install dependencies
      - name: Install node
        uses: actions/setup-node@v6
        with:
          node-version: 18.x

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

      # Build and upload docs
      - name: Build book
        run: uv run jupyter book build --html --execute

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: "./_build/html"

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4