deploy-docs.yml

name: Deploy docs to Pages

on:
  push:
    branches: ['main']

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: 'pages'
  cancel-in-progress: true

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Use Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - run: ./scripts/dev-init.sh

      - run: npm -w packages/web-docs run build

      - name: Generate API client docs
        run: |
          npx typedoc
          mv reports/api-docs packages/web-docs/build/api-docs

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: './packages/web-docs/build'

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