ci.yml

name: CI
on:
  push:
    branches:
      - '**'
      - '!integrated/**'
      - '!stl-preview-head/**'
      - '!stl-preview-base/**'
      - '!generated'
      - '!codegen/**'
      - 'codegen/stl/**'
  pull_request:
    branches-ignore:
      - 'stl-preview-head/**'
      - 'stl-preview-base/**'
  workflow_dispatch:
  # Exercise the complete supported matrix and the next CPython prerelease
  # even when the repository has not changed.
  schedule:
    - cron: '47 9 * * *'

jobs:
  lint:
    timeout-minutes: 10
    name: lint
    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
    if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

      - name: Set up Rye
        uses: eifinger/setup-rye@c694239a43768373e87d0103d7f547027a23f3c8
        with:
          version: '0.44.0'
          enable-cache: true

      - name: Install dependencies
        run: rye sync --all-features

      - name: Run lints
        run: ./scripts/lint

  build:
    if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')
    timeout-minutes: 10
    name: build
    permissions:
      contents: read
      id-token: write
    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

      - name: Set up Rye
        uses: eifinger/setup-rye@c694239a43768373e87d0103d7f547027a23f3c8
        with:
          version: '0.44.0'
          enable-cache: true

      - name: Install dependencies
        run: rye sync --all-features

      - name: Run build
        run: rye build

      - name: Validate Python version metadata
        run: rye run python scripts/utils/validate-python-version-wheel.py

      - name: Validate Bedrock wheel
        run: rye run python scripts/utils/validate-bedrock-wheel.py

      - name: Validate HTTPX2 wheel on Python 3.10
        run: rye run python scripts/utils/validate-httpx2-wheel.py

      - name: Set up Python 3.9 for resolver rejection
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: '3.9'

      - name: Prove Python 3.9 rejects the wheel
        run: python scripts/utils/validate-python-version-wheel.py --check-python-39

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

      - name: Validate HTTPX2 wheel on Python 3.14
        run: python scripts/utils/validate-httpx2-wheel.py

      - name: Get GitHub OIDC Token
        if: |-
          github.repository == 'stainless-sdks/openai-python' &&
          !startsWith(github.ref, 'refs/heads/stl/')
        id: github-oidc
        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
        with:
          script: core.setOutput('github_token', await core.getIDToken());

      - name: Upload tarball
        if: |-
          github.repository == 'stainless-sdks/openai-python' &&
          !startsWith(github.ref, 'refs/heads/stl/')
        env:
          URL: https://pkg.stainless.com/s
          AUTH: ${{ steps.github-oidc.outputs.github_token }}
          SHA: ${{ github.sha }}
        run: ./scripts/utils/upload-artifact.sh

  test:
    timeout-minutes: 15
    name: test (Python ${{ matrix.python-version }})
    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
    strategy:
      fail-fast: false
      matrix:
        # Per-PR coverage protects both ends of the support window.
        python-version: ["3.10", "3.14"]
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

      - name: Set up Python ${{ matrix.python-version }}
        id: setup-python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: ${{ matrix.python-version }}

      - name: Set up Rye
        uses: eifinger/setup-rye@c694239a43768373e87d0103d7f547027a23f3c8
        with:
          version: '0.44.0'
          enable-cache: false

      - name: Select Python ${{ matrix.python-version }}
        run: |
          rye toolchain register "${{ steps.setup-python.outputs.python-path }}"
          rye pin --relaxed --no-update-requires-python "${{ matrix.python-version }}"

      - name: Bootstrap
        run: ./scripts/bootstrap

      - name: Run tests
        run: ./scripts/test

  test-httpx2:
    timeout-minutes: 20
    name: test (HTTPX2)
    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

      - name: Set up Python 3.14
        id: setup-python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: '3.14'

      - name: Set up Rye
        uses: eifinger/setup-rye@c694239a43768373e87d0103d7f547027a23f3c8
        with:
          version: '0.44.0'
          enable-cache: false

      - name: Install HTTPX2 test dependencies
        run: |
          rye toolchain register "${{ steps.setup-python.outputs.python-path }}"
          rye pin --relaxed --no-update-requires-python 3.14
          rye sync --all-features

      - name: Run tests with HTTPX and HTTPX2 installed
        env:
          OPENAI_TEST_HTTP_CLIENT: httpx
        run: ./scripts/test

      - name: Run tests with HTTPX2
        env:
          OPENAI_TEST_HTTP_CLIENT: httpx2
        run: ./scripts/test

  examples:
    timeout-minutes: 10
    name: examples
    environment: ci
    runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
    if: github.repository == 'openai/openai-python' && (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata')

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

      - name: Set up Rye
        uses: eifinger/setup-rye@c694239a43768373e87d0103d7f547027a23f3c8
        with:
          version: '0.44.0'
          enable-cache: true
      - name: Install dependencies
        run: |
          rye sync --all-features

      - env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
        run: |
            rye run python examples/demo.py
      - env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
        run: |
            rye run python examples/async_demo.py

  python-policy:
    timeout-minutes: 5
    name: Python support policy
    runs-on: ubuntu-latest
    if: github.event_name != 'schedule'
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          persist-credentials: false

      - name: Check version-policy surfaces
        run: python scripts/check-python-version-policy.py

  compatibility:
    timeout-minutes: 20
    name: compatibility (Python ${{ matrix.python-version }})
    runs-on: ubuntu-latest
    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
    continue-on-error: ${{ matrix.experimental }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - python-version: "3.10"
            experimental: false
          - python-version: "3.11"
            experimental: false
          - python-version: "3.12"
            experimental: false
          - python-version: "3.13"
            experimental: false
          - python-version: "3.14"
            experimental: false
          - python-version: "3.15"
            experimental: true
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
        with:
          persist-credentials: false

      - name: Set up Python ${{ matrix.python-version }}
        id: setup-python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: ${{ matrix.python-version }}
          allow-prereleases: ${{ matrix.experimental }}

      - name: Set up Rye
        uses: eifinger/setup-rye@c694239a43768373e87d0103d7f547027a23f3c8
        with:
          version: '0.44.0'
          enable-cache: false

      - name: Select Python ${{ matrix.python-version }}
        run: |
          rye toolchain register "${{ steps.setup-python.outputs.python-path }}"
          rye pin --relaxed --no-update-requires-python "${{ matrix.python-version }}"

      - name: Install dependencies
        run: rye sync --all-features

      - name: Smoke-test the supported runtime
        run: |
          rye run python -c 'import openai; from openai import AsyncOpenAI, OpenAI'
          rye run pytest -o addopts= --quiet \
            tests/test_client.py \
            tests/test_streaming.py \
            tests/lib/test_pydantic.py