name: "Verify build (docs)"

# Preflight build of docs. This allows us to ensure that yarn build is
# succeeding before we merge the PR into main.

on:
    # Run on every push to a branch other than main that changes docs/
    push:
        branches-ignore: [main, "deploy/**"]
        paths:
            - "docs/**"
            - ".github/workflows/docs-verify-build.yml"

jobs:
    verify-build:
        runs-on: ubuntu-latest

        defaults:
            run:
                working-directory: docs

        steps:
            - name: Checkout code
              uses: actions/checkout@v4

            - name: Setup node and enable yarn caching
              uses: actions/setup-node@v4
              with:
                  node-version: 20
                  cache: "yarn"
                  cache-dependency-path: "docs/yarn.lock"

            - name: Install dependencies
              run: yarn install

            - name: Build production site
              run: yarn build