litellm/.github/workflows/test-unit-documentation.yml

name: "Unit Tests: Documentation Validation"

on:
  pull_request:
    branches:
      - main
      - "litellm_**"
  push:
    branches:
      - main

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  documentation:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    permissions:
      contents: read
      pull-requests: read

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Detect relevant changes
        id: changes
        uses: ./.github/actions/detect-changes

      - name: Checkout litellm-docs into docs/my-website (for documentation_tests)
        if: steps.changes.outputs.decision != 'skip'
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          repository: BerriAI/litellm-docs
          path: docs/my-website
          persist-credentials: false

      - name: Set up Python
        if: steps.changes.outputs.decision != 'skip'
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: "3.12"

      - name: Set up uv
        if: steps.changes.outputs.decision != 'skip'
        uses: ./.github/actions/setup-uv-with-retries
        with:
          version: "0.10.9"

      - name: Cache uv dependencies
        if: steps.changes.outputs.decision != 'skip'
        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
        with:
          path: |
            ~/.cache/uv
            .venv
          key: ${{ runner.os }}-uv-${{ hashFiles('uv.lock') }}
          restore-keys: |
            ${{ runner.os }}-uv-

      - name: Cache the Rust build
        if: steps.changes.outputs.decision != 'skip'
        uses: ./.github/actions/cache-cargo-build

      - name: Install dependencies
        if: steps.changes.outputs.decision != 'skip'
        run: |
          .github/scripts/uv_sync_with_retries.sh --frozen --group ci --group proxy-dev --extra google --extra proxy --extra semantic-router

      - name: Cache Prisma binaries
        if: steps.changes.outputs.decision != 'skip'
        uses: ./.github/actions/cache-prisma-binaries

      - name: Generate Prisma client
        if: steps.changes.outputs.decision != 'skip'
        run: |
          uv run --no-sync prisma generate --schema litellm/proxy/schema.prisma

      # Run the same documentation tests that CircleCI ran (as direct Python scripts)
      - name: Run documentation validation tests
        if: steps.changes.outputs.decision != 'skip'
        run: |
          uv run --no-sync python ./tests/documentation_tests/test_env_keys.py
          uv run --no-sync python ./tests/documentation_tests/test_router_settings.py
          uv run --no-sync python ./tests/documentation_tests/test_api_docs.py
          uv run --no-sync python ./tests/documentation_tests/test_circular_imports.py