site.yml

name: Deploy TypeDoc docs to GitHub Pages

# Based on https://raw.githubusercontent.com/actions/starter-workflows

on:
    # Runs on pushes targeting the master branch
    push:
        branches: [master]

    # Allows you to run this workflow manually from the Actions tab
    workflow_dispatch:

env:
    CI: true
    FORCE_COLOR: 2
    NODE: 16

# 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:
    # Build job
    build:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v3
            - name: Setup Node
              uses: actions/setup-node@v3.5.1
              with:
                  node-version: "${{ env.NODE }}"
                  cache: "npm"
            - name: Setup Pages
              id: pages
              uses: actions/configure-pages@v4
            - name: Install dependencies
              run: npm ci
            - name: Build docs
              run: npm run build:docs
            - name: Upload artifact
              uses: actions/upload-pages-artifact@v2
              with:
                  path: ./docs

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