python.yaml

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Code Quality and Unit Testing

on:
  push:
    branches: [main]
    paths-ignore:
      - 'docs/**'
      - 'notebooks/**'
      - 'scripts/**'
  pull_request:
    branches: ['*']
    paths-ignore:
      - 'docs/**'
      - 'notebooks/**'
      - 'scripts/**'

permissions:
  contents: read

jobs:
  tests:
    runs-on: ubuntu-latest
    timeout-minutes: 30

    steps:
      - uses: actions/checkout@v4

      - name: Set up Python 3.9
        uses: actions/setup-python@v5
        with:
          python-version: '3.9'

      - name: Install uv
        uses: astral-sh/setup-uv@v5
        with:
          enable-cache: true
          # Keep downloaded wheels between runs (the default prunes them before saving)
          prune-cache: false
          # Key on pyproject.toml, not uv.lock, so lock-only bumps reuse the cache. On Python 3.9
          # blis and thinc have no wheels and take ~8 min to compile on every cache miss.
          cache-dependency-glob: pyproject.toml

      - name: Install Dependencies
        run: |
          uv sync --all-extras --group dev
          uv pip install aequitas fairlearn vl-convert-python

      - name: Ensure notebooks have no printed outputs
        run: make ensure-clean-notebooks

      - name: Verify Copyright Header
        run: make verify-copyright

      - name: Verify Exposed Credentials
        run: make verify-exposed-credentials

      - name: Code Quality
        run: make lint

      - name: Unit Tests
        run: make test

      # Tests that we can build the docs
      - name: Generate Docs
        run: make docs

      # Tests that we can build the quarto docs
      - name: Generate Quarto Docs
        run: make quarto-docs