docs.yml

name: 'Create & publish documentation'

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
      - '*'
    types:
      - closed

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Setup pnpm
        uses: pnpm/action-setup@v3

      - name: Use Node.js
        uses: actions/setup-node@v4
        with:
          node-version-file: '.nvmrc'
          cache: 'pnpm'

      - run: pnpm install --no-frozen-lockfile

  docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - uses: actions/checkout@v4

      - name: Setup pnpm for docs
        uses: pnpm/action-setup@v3

      - name: Use Node.js for docs
        uses: actions/setup-node@v4
        with:
          node-version-file: '.nvmrc'
          cache: 'pnpm'

      - run: pnpm install --no-frozen-lockfile

      - run: pnpm typedoc

      - name: Deploy documentation
        uses: JamesIves/github-pages-deploy-action@v4.4.3
        with:
          branch: gh-pages
          folder: api-docs