docs-sync.yml

name: Docs Sync Check

on:
  pull_request:
    branches: [main, dev]
  push:
    branches: [dev, main]

jobs:
  check:
    name: Verify documentation matches code changes
    runs-on: ubuntu-latest

    steps:
      - name: Checkout (with full history for diff)
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"

      - name: Install dependencies
        run: pip install pyyaml

      - name: Determine base ref
        id: base
        run: |
          if [ -n "${{ github.base_ref }}" ]; then
            echo "ref=origin/${{ github.base_ref }}" >> "$GITHUB_OUTPUT"
          else
            # Push event: compare against the previous commit on this branch
            echo "ref=${{ github.event.before }}" >> "$GITHUB_OUTPUT"
          fi

      - name: Run doc-sync check
        run: |
          python scripts/check_docs_sync.py --base "${{ steps.base.outputs.ref }}"