docs-deploy.yml

name: docs-deploy

on:
  push:
    branches: ['main', 'master']

permissions:
  contents: write

concurrency:
  group: docs-deploy-${{ github.ref }}
  cancel-in-progress: true

jobs:
  deploy:
    runs-on: ubuntu-latest
    timeout-minutes: 15

    steps:
      - name: Checkout
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4

      - name: Safety check - only deploy from default branch
        shell: bash
        run: |
          if [[ "${GITHUB_REF_NAME}" != "${{ github.event.repository.default_branch }}" ]]; then
            echo "Error: docs-deploy must run from the default branch (${{ github.event.repository.default_branch }}), got ${GITHUB_REF_NAME}"
            exit 1
          fi

      - name: Setup Python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
        with:
          python-version: '3.12'

      - name: Install dependencies
        working-directory: site-docs
        run: pip install -r requirements.txt

      - name: Configure git author
        run: |
          git config user.name github-actions
          git config user.email github-actions@users.noreply.github.com

      - name: Deploy docs to gh-pages
        working-directory: site-docs
        run: mkdocs gh-deploy --force