python-compatibility.yml

# Python Compatibility Testing Workflow
#
# Tests Python package build compatibility across:
# - Operating Systems: Ubuntu
# - Python Versions: 3.10 (floor), 3.14 (ceiling)
#
# Validates that the package can be built and installed correctly
# on the supported Python versions.

name: Python Compatibility Check

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

on:
  workflow_dispatch:
  push:
  pull_request:

env:
  # Change this to invalidate existing cache.
  CACHE_PREFIX: v0
  PYTHON_PATH: ./

permissions:
  contents: read

jobs:
  checks:
    name: Python ${{ matrix.python }} - ${{ matrix.os }} - ${{ matrix.task.name }}
    runs-on: ${{ matrix.os }}
    timeout-minutes: 30
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]  
        python: ['3.10', '3.14']
        task:
          - name: Build
            run: |
              pip list
              pip install twine
              pip install --upgrade setuptools wheel
              pip list
              python setup.py check
              python setup.py bdist_wheel sdist
              twine check ./dist/*

    steps:
      - uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python }}

      - name: Install prerequisites
        run: |
          python -m pip install --upgrade pip setuptools wheel

      - name: Set build variables
        shell: bash
        run: |
          echo "PYTHON_VERSION=$(python --version)" >> $GITHUB_ENV

      - name: Test dependency wheels availability
        run: |
          python -m venv .venv-deps-test
          . .venv-deps-test/bin/activate
          # Try installing with wheel-only first to catch dependency conflicts early
          pip install --only-binary=:all: -r requirements.txt || {
            echo "Warning: Some dependencies may not have wheels available"
            echo "Attempting installation with source packages allowed..."
            pip install -r requirements.txt
          }
          deactivate
          rm -rf .venv-deps-test
        shell: bash

      - name: Setup virtual environment
        run: |
          python -m venv .venv
          . .venv/bin/activate
          pip install -e .[dev]
        shell: bash

      - name: Show environment info
        run: |
          . .venv/bin/activate
          which python
          python --version
          pip freeze
        shell: bash

      # Web build steps - tests TypeScript/web components compilation and bundling
      # Uncomment if you need to verify that web components work with your Python package changes
      # - name: Build Web
      #   run: |
      #     pnpm build:typespec
      #     pnpm build:web
      #     pnpm bundle
      #   env:
      #     CI: false
      
      # TypeSpec emitter testing - tests the TypeSpec-to-code generation functionality
      # Uncomment if you need to verify TypeSpec emitter compatibility with your Python changes
      # - name: Test Typespec-aaz Emitter
      #   run: |
      #       pnpm test-aaz-emitter

      - name: ${{ matrix.task.name }}
        run: |
          . .venv/bin/activate
          ${{ matrix.task.run }}
        shell: bash