name: Check Configuration Docs

# Manual-only check. Config docs are auto-regenerated by the version bump
# workflow (version_check.yml) on every push to main, so a blocking PR
# check is unnecessary and creates manual work for contributors.
on:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  check-config-docs:
    runs-on: ubuntu-latest

    steps:
      - name: Harden the runner (Audit all outbound calls)
        uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4
        with:
          egress-policy: audit

      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
        with:
          python-version: '3.12'

      - name: Check configuration docs are up to date
        run: python scripts/generate_config_docs.py --check