docs.yml

name: Docs

# Builds the TypeDoc API docs and deploys them to GitHub Pages — replacing the
# old `gh-pages` npm dependency with first-party GitHub Actions.
#
# Publishes on every new version tag (e.g. created by `npm version`), so the
# docs site always reflects the latest release. Also runnable manually.
#
# One-time repo setting: Settings -> Pages -> Build and deployment -> Source ->
# "GitHub Actions".
on:
  push:
    tags:
      - 'v*'
  workflow_dispatch:

# Least-privilege token plus the Pages/OIDC scopes the deploy needs.
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one in-flight Pages deployment at a time; don't cancel a running one.
concurrency:
  group: pages
  cancel-in-progress: false

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

      - name: Use Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 22.x
          cache: 'npm'

      - name: Install
        run: npm ci

      - name: Build docs
        run: npm run docs

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

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