pages.yml

name: "Generate & Publish Documentation"
on:
    push:
        branches:
            - main

jobs:
    build:
        runs-on: ubuntu-latest

        steps:
            - name: Checkout
              uses: actions/checkout@v3
              with:
                  # Make sure the actual branch is checked out when running on pull requests
                  ref: ${{ github.head_ref }}
                  repository: ${{github.event.pull_request.head.repo.full_name || github.repository }}

            - name: Use Node.js 18.x
              uses: actions/setup-node@v3
              with:
                  node-version: 18.x

            - name: Install dependencies
              run: yarn install --immutable

            - name: Generate documentation
              run: yarn run docs

            - name: Set up Pages
              uses: actions/configure-pages@v3

            - name: Upload Artifact
              uses: actions/upload-pages-artifact@v1
              with:
                  path: docs

    publish:
        runs-on: ubuntu-latest
        needs: build

        permissions:
            contents: write
            pages: write
            id-token: write

        concurrency:
            group: pages
            cancel-in-progress: true

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