typedoc.yml

name: Typedoc

on:
  # Triggers the workflow on push or pull request events but only for the "main" branch
  push:
    branches: [ "main" ]

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

jobs:
  typedoc:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
          token: ${{ secrets.GH_PAT }}

      - name: "Use NodeJS 16"
        uses: actions/setup-node@v2
        with:
          node-version: '16'
          cache: 'yarn'

      - name: "Install dependencies"
        run: |
          yarn install

      - name: TSC
        run: |
          yarn tsc

      - name: Docs
        run: |
          yarn docs

      - name: Publish pages 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.4
        with:
          branch: gh-pages
          folder: docs