docs.yaml

name: Deploy API Documentation

on:
  release:
    types: [published]

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          cache: 'npm'
          cache-dependency-path: |
            package-lock.json
          node-version: '20'

      - name: Install and Build 🔧
        run: |
          npm ci
          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@releases/v4
        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/**