docs.yml

name: Docs

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "schemas/**"
      - "mkdocs.yml"
      - "requirements-docs.txt"
      - "README.md"
      - "CHANGELOG.md"
      - "CONTRIBUTING.md"
      - "GOVERNANCE.md"
      - "ROADMAP.md"
      - "LIMITATIONS.md"
      - "CNAME"
      - "overrides/**"
  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"

      # Every schema declares $id https://cmcp.agentrust-io.com/schemas/<file>,
      # which is the URL an implementation fetches. They live at the repository
      # root, outside docs_dir, so the site never served them and each $id
      # returned 404. Stage them into the build instead of committing a second
      # copy, so the files under schemas/ stay the only source and cannot drift.
      - name: Stage the published schemas into the docs tree
        run: |
          set -euo pipefail
          mkdir -p docs/schemas
          cp schemas/*.json docs/schemas/
          for f in docs/schemas/*.json; do
            want="https://cmcp.agentrust-io.com/schemas/$(basename "$f")"
            got=$(python -c "import json,sys;print(json.load(open(sys.argv[1]))['\$id'])" "$f")
            if [ "$got" != "$want" ]; then
              echo "::error::$f declares \$id '$got' but is served at '$want'"
              exit 1
            fi
          done

      - name: Build and deploy to GitHub Pages
        run: mkdocs gh-deploy --force --clean