deploy-docs.yml

name: Build and Deploy Docs
on:
    push:
        branches:
            - main

permissions: {}

jobs:
    build-and-deploy-docs:
        runs-on: ubuntu-latest
        permissions:
            contents: write
        steps:
            - name: Checkout
              uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
              with:
                  persist-credentials: false
            - name: Setup Node.js
              uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
              with:
                  node-version: '20'
            # Pre-check to validate that versions match between package.json
            # and package-lock.json. Needs to run before npm install
            - name: Validate package.json and package-lock.json versions
              run: node version-check.js
            - name: Install dependencies
              run: npm ci
            - name: Build docs
              run: npm run docs

            - name: Deploy docs
              uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
              with:
                  branch: gh-pages # The branch the action should deploy to.
                  folder: docs # The folder the action should deploy.