docs-deploy.yml

# Deploys the documentation to GitHub Pages
name: docs-deploy
on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
  workflow_dispatch:

env:
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Install node and pnpm
        uses: smartcontractkit/.github/actions/setup-nodejs@setup-nodejs/v1
        with:
          pnpm-version: 11.1.1
          package-json-directory: ./docs

      - name: Build docs
        run: pnpm -C ./docs build

      - name: Upload Build Artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: ./docs/build

  deploy:
    name: Deploy to GitHub Pages
    runs-on: ubuntu-latest
    needs: build
    permissions:
      pages: write    # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

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