deploy-docs.yml

name: Deploy Docs

# Standalone MkDocs deploy workflow. Replaced by a call to
# AzureLocal/platform/.github/workflows/reusable-mkdocs-deploy.yml@v1
# once that reusable workflow ships in Phase 3.

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'requirements-docs.txt'
      - '.github/workflows/deploy-docs.yml'
  workflow_dispatch:

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

concurrency:
  group: pages-${{ github.ref }}
  cancel-in-progress: false

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0          # required for git-revision-date-localized plugin

      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
          cache: pip
          cache-dependency-path: requirements-docs.txt

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

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

      - name: Build and deploy
        run: mkdocs gh-deploy --force --clean --verbose