docs.yaml

name: Deploy API Documentation

on:
  release:
    types: [published]

permissions:
  contents: read

jobs:
  build-and-deploy:
    permissions:
      contents: write # required for deploying documentation to gh-pages
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
        with:
          cache: 'npm'
          cache-dependency-path: |
            package-lock.json
          node-version: '22'

      - name: Install and Build 🔧
        run: |
          npm ci --ignore-scripts
          npm run compile

      - name: Build Docs
        run: npm run docs
        env:
          NODE_OPTIONS: --max-old-space-size=6144

      - name: Deploy Documentation 🚀
        uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
        with:
          branch: gh-pages # The branch the action should deploy to.
          folder: docs # The folder the action should deploy.
          # ensure we don't override benchmark data
          clean-exclude: |
            benchmarks/**