docs.yml

name: docs

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

concurrency:
  group: docs-${{ github.head_ref }}
  cancel-in-progress: true

permissions:
  contents: read
  id-token: write
  pull-requests: write
  checks: write

jobs:
  build:
    strategy:
      fail-fast: false
      matrix:
        python-version: [3.11]
        node-version: [18]

    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: arduino/setup-task@v2

      # ------------------------------------------------------------------------
      # Set up JS

      - name: Set up pnpm
        uses: pnpm/action-setup@v3
        with:
          version: 8

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}

      - name: Install JS deps
        run: |
          task js:install

      - name: Build JS
        run: |
          task js:build

      # ------------------------------------------------------------------------
      # Setup Python

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - uses: actions/cache@v4
        id: cached-python-env
        with:
          path: ${{ env.pythonLocation }}
          key: >
            python-env
            ${{ runner.os }}
            python-${{ matrix.python-version }}
            ${{ hashFiles('pyproject.toml') }}
            ${{ hashFiles('requirements/*') }}

      - name: Install dependencies
        # if: steps.cached-python-env.outputs.cache-hit != 'true'
        run: pip install -r requirements-dev.lock

      - name: Install Hatch
        run: pip install --upgrade hatch

      # ------------------------------------------------------------------------
      # Test

      - name: Build package
        run: hatch build

      - name: Install package
        run: |
          pip install dist/*.tar.gz
          pip freeze

      - name: Build demo docs
        run: |
          task docs:build

      - name: Cache website
        id: cache-build
        uses: actions/cache@v4
        with:
          path: demo/dist
          key: >
            website
            ${{ github.run_id }}
            ${{ github.run_attempt }}

  cf-pages:
    uses: ./.github/workflows/docs-cf-pages.yml
    needs: [build]
    secrets: inherit

  post-deploy:
    uses: ./.github/workflows/docs-post.yml
    needs: [cf-pages]
    secrets: inherit