docs.yml

name: Build and Publish API Docs

on:
  push:
    branches:
      - master
      - 65-api-docs

jobs:
  build-and-publish-docs:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2

    - name: Use Node.js 16
      uses: actions/setup-node@v2
      with:
        node-version: 16

    - name: Get Node.js version
      id: get-node-version
      run: echo "::set-output name=node-version::$(node --version)"

    - name: Install Yarn
      if: ${{ env.ACT }}
      run: npm i yarn -g

    - name: Get yarn cache directory path
      id: get-yarn-cache-path
      run: |
        yarn cache dir
        echo "::set-output name=yarn-cache-path::$(yarn cache dir)"

    - uses: actions/cache@v2
      id: yarn-cache
      with:
        path: ${{ steps.get-yarn-cache-path.outputs.yarn-cache-path }}
        key: ${{ runner.os }}_node-${{ steps.get-node-version.outputs.node-version }}_yarn-${{ hashFiles('**/yarn.lock') }}

    - name: 📦 Install Dependencies
      run: |
        yarn install --frozen-lockfile
        cd docs
        yarn install --frozen-lockfile

    - name: 📚 Docs - 🔨 Build
      working-directory: docs
      run: yarn typedoc

    - name: 📚 Docs - 🚀 Publish
      uses: JamesIves/github-pages-deploy-action@4.1.4
      with:
        branch: gh-pages # The branch the action should deploy to.
        folder: docs/dist # The folder the action should deploy.