deploy-docs.yaml

name: Deploy Docs
on:
  push:
    branches:
      - "main"
    paths:
      - "docs/**"
      - "mkdocs.yml"
  workflow_dispatch:
  workflow_run:
    workflows:
      - "Spelling"
    types:
      - completed

permissions:
  contents: read
  pages: write
  id-token: write

# only one GitHub Pages Deploy workflow at a time
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Setup Python
        uses: actions/setup-python@v6
        with:
          python-version: 3.12
      - run: |
          pip install -r docs/requirements.txt
      - name: Build MkDocs
        run: |
          mkdocs build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: './site'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5