main-docs.yml

name: deploy documentation

# Builds the docs site and publishes it to the gh-pages branch, which is what
# GitHub Pages serves. Authenticates with the automatic GITHUB_TOKEN, so there
# is no deploy key or secret to maintain.
on:
  push:
    branches: [main]

jobs:
  build_docs_job:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Set up Node
      uses: actions/setup-node@v4
      with:
        # Docusaurus 3 requires Node >= 20. This was previously left to the
        # runner default, which happened to be new enough but was not pinned.
        node-version: '20.x'
    - name: Build the Website
      run: |
        cd docs
        yarn install --frozen-lockfile
        npm run build
    - name: Deploy
      uses: JamesIves/github-pages-deploy-action@releases/v3
      with:
          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages # The branch the action should deploy to.
          FOLDER: docs/build # The folder the action should deploy.