docs.yml

name: Deploy docs

on:
  push:
    branches: [master]
    paths:
      - 'docs/**'
      - 'src/**'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    name: Build docs site
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: docs
    steps:
      - uses: actions/checkout@v4

      # Pages `build_type` must be `workflow` for `actions/deploy-pages`
      # to accept artifacts. That setting is flipped via the repo
      # owner once (Settings → Pages → Source: GitHub Actions) or with
      # `gh api -X PUT repos/<owner>/<repo>/pages -F build_type=workflow`
      # from an admin-authed gh CLI. The workflow can't flip it itself:
      # `GITHUB_TOKEN` with `pages: write` is enough to DEPLOY, but the
      # Pages admin API (PUT /pages) requires repo-admin scope, which
      # the workflow token doesn't carry.

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
          cache-dependency-path: docs/package-lock.json
      - run: npm ci
      - run: npm run build
      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/dist

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