docs.yml

name: Docs Update
on:
  push:
    branches:
      - master
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'README.md'
      - 'CODE_OF_CONDUCT.md'
      - 'CONTRIBUTING.md'
      - 'LICENSE'
      - 'SECURITY.md'
      - 'CHANGELOG.md'
      - 'AGENTS.md'
      - 'CLAUDE.md'
      - '**/SKILL.md'
    tags:
      - 'v*'
  workflow_dispatch:

permissions:
  contents: write

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

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v7
        with:
          python-version: '3.14'

      - name: Install dependencies
        run: |
          pip install mkdocs-material
          pip install "mkdocstrings[python]"
          pip install mike
          pip install pymarkdownlnt
          pip install -e .

      - name: Lint documentation
        run: |
          pymarkdownlnt scan -r -e ./.venv -e ./.git -e ./.github -e ./data -e ./tornadoapi_guard -e ./tests .

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

      - name: Deploy documentation
        run: |
          mike deploy --push latest
          mike set-default --push latest

      - name: Deploy to GitHub Pages
        run: |
          mike list
          git push origin gh-pages --force