test-unit-documentation.yml

name: "Unit Tests: Documentation Validation"

on:
  pull_request:
    branches:
      - main
      - litellm_internal_staging
      - litellm_oss_branch
      - "litellm_**"

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  documentation:
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
        with:
          persist-credentials: false

      - name: Checkout litellm-docs into docs/my-website (for documentation_tests)
        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
        with:
          repository: BerriAI/litellm-docs
          path: docs/my-website
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: "3.12"

      - name: Set up uv
        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
        with:
          version: "0.10.9"

      - name: Cache uv dependencies
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
        with:
          path: |
            ~/.cache/uv
            .venv
          key: ${{ runner.os }}-uv-${{ hashFiles('uv.lock') }}
          restore-keys: |
            ${{ runner.os }}-uv-

      - name: Install dependencies
        run: |
          uv sync --frozen --group ci --group proxy-dev --extra google --extra proxy --extra semantic-router

      - name: Generate Prisma client
        env:
          PRISMA_BINARY_CACHE_DIR: ${{ runner.temp }}/prisma-cache
        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
        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