docs.yml

name: Docs

# auto build TypeDoc from the TSDoc annotations & publish to GitHub Pages on every
# push to main. needs Pages enabled once: repo Settings => Pages => Source: GitHub Actions
on:
  push:
    branches: [main]
  workflow_dispatch:

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

# never cancel an in-flight Pages deploy, queue instead (recommended for pages)
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Install pnpm
        uses: pnpm/action-setup@v6

      - name: Setup Node
        uses: actions/setup-node@v7
        with:
          node-version: 22
          cache: pnpm

      - name: Install dependencies
        run: pnpm install --frozen-lockfile

      # `pnpm run docs`, not `pnpm docs` => `docs` collides with the built-in
      # `npm docs` command (opens the pkg page in a browser), which is what the
      # bare form resolved to on the runner => exit 3. `run` forces our script.
      - name: Generate docs (TypeDoc => docs/)
        run: pnpm run docs

      - name: Configure Pages
        uses: actions/configure-pages@v6

      - name: Upload docs artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs

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