name: Deploy Documentation

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'golem.toml'
      - 'pyproject.toml'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

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

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

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

      - name: Restore Golem build cache
        uses: actions/cache@v4
        with:
          path: .golem/cache.json
          key: golem-cache-${{ runner.os }}-${{ hashFiles('docs/**', 'golem.toml', 'pyproject.toml') }}
          restore-keys: |
            golem-cache-${{ runner.os }}-

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          # golem-docs[docs] is self-hosting: the [docs] extra declares golem-docs
          # itself as a dependency, satisfied by the wheel just installed.
          python -m pip install "golem-docs[docs]"

      - name: Generate API reference docs
        run: |
          # docs/api/ is excluded from git — generated fresh from source on every deploy
          golem apidoc

      - name: Compile documentation site
        run: |
          golem build --strict --clean

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: dist/

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

PYTHON_VERSION = 3.14

image: python:3.14-slim

pages:
  stage: deploy
  cache:
    key: golem-cache
    paths:
      - .golem/cache.json
      - .cache/pip
  before_script:
    - pip install --upgrade pip
    - pip install golem-docs
  script:
    - golem apidoc  # docs/api/ excluded from git; regenerated fresh on every deploy
    - golem build --strict --clean
    - mv dist public
  artifacts:
    paths:
      - public
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH