docs.yml

name: Docs

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - "requirements-docs.txt"
      - "README.md"
      - "CHANGELOG.md"
      - "CONTRIBUTING.md"
      - "GOVERNANCE.md"
      - "ROADMAP.md"
      - "LIMITATIONS.md"
      - "CNAME"
      - "overrides/**"
      - "index.md"
      - "CHARTER.md"
      - "CODE_OF_CONDUCT.md"
      - "SECURITY.md"
      - "PRIVACY.md"
  workflow_dispatch:

permissions:
  contents: write

concurrency:
  group: docs-deploy
  cancel-in-progress: false

jobs:
  deploy:
    name: Build and deploy docs
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: "3.11"
          cache: pip

      - name: Install docs dependencies
        run: |
          pip install --require-hashes -r requirements/docs.txt
          pip install --require-hashes -r requirements/dev.txt
          pip install --no-deps -e .

      - name: Configure git for gh-deploy
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"

      - name: Assemble docs build directory
        run: |
          BUILD=.docs_build
          mkdir -p $BUILD

          if [ -d docs ]; then cp -r docs $BUILD/docs; fi

          for fname in index.md CHANGELOG.md CONTRIBUTING.md GOVERNANCE.md CHARTER.md CODE_OF_CONDUCT.md SECURITY.md PRIVACY.md ROADMAP.md LIMITATIONS.md SPONSORS.md CNAME; do
            if [ -f "$fname" ]; then cp "$fname" "$BUILD/$fname"; fi
          done

          echo "Build dir contains $(find $BUILD -type f | wc -l) files"

      - name: Generate build config
        run: |
          # Strip CR before sed so the docs_dir match is robust to CRLF line endings.
          tr -d '\r' < mkdocs.yml | sed 's|^docs_dir: \.$|docs_dir: .docs_build|' > .mkdocs_build.yml

      - name: Build and deploy to GitHub Pages
        run: mkdocs gh-deploy --force --clean --config-file .mkdocs_build.yml