documentation.yaml

name: documentation

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]
  pull_request:
  merge_group:

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# 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

defaults:
  run:
    shell: bash

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install the latest version of uv
        uses: astral-sh/setup-uv@v1
        with:
          version: "latest"
          enable-cache: true
          cache-dependency-glob: "uv.lock"

      - name: Install Python
        run: uv python install

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

      - name: Build the python index
        run: |
          LATEST_RELEASE=$(gh release list --limit 1 --json tagName | jq -r .[0].tagName)
          uvx dumb-pypi \
            --package-list <(gh release view $LATEST_RELEASE --json assets | jq -r .assets[].name) \
            --packages-url https://github.com/jumpstarter-dev/jumpstarter/releases/download/$LATEST_RELEASE \
            --title "Jumpstarter Python Packages" --output-dir docs/source/extra/packages
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Build the documentation
        run: uv run --all-extras make docs

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/build/html

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    if: github.ref == 'refs/heads/main'
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4