docs.yml

name: Build Docs

on:
    push:
        branches:
            - main
    workflow_dispatch:

jobs:
    build_docs:
        name: Build Docs
        runs-on: ubuntu-latest
        steps:
            - name: Checkout Repository
              uses: actions/checkout@v2

            - name: Cache PNPM Modules
              uses: actions/cache@v2
              with:
                  path: ~/.pnpm-store
                  key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
                  restore-keys: |
                      ${{ runner.os }}-pnpm-

            - name: Setup PNPM
              uses: pnpm/action-setup@v2.0.1
              with:
                  version: latest
                  run_install: true

            - name: TypeDoc Build
              run: npm run docs

            - name: Deploy to GitHub Pages
              uses: peaceiris/actions-gh-pages@v3
              with:
                  github_token: ${{ secrets.GITHUB_TOKEN  }}
                  publish_dir: "./docs"
                  user_name: "JacobLinCool"
                  user_email: "jacoblincool@users.noreply.github.com"
                  publish_branch: "gh-pages"