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

    steps:
      # TODO figure out why VM Library requires so much disk space and fix that
      # - name: Free Disk Space (Ubuntu)
      #   uses: jlumbroso/free-disk-space@main
      #   with:
      #     # this might remove tools that are actually needed,
      #     # if set to "true" but frees about 6 GB
      #     tool-cache: false

      #     # all of these default to true, but feel free to set to
      #     # "false" if necessary for your workflow
      #     android: true
      #     dotnet: true
      #     haskell: true
      #     large-packages: true
      #     docker-images: true
      #     swap-storage: true

      - uses: actions/checkout@v4

      - name: Free Disk Space
        run: ./disk_clean.sh

      - name: Install poetry
        run: pipx install poetry

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

      - name: Install Dependencies
        run: |
          poetry env use python3.9
          poetry run pip install pyarrow==17.0.0
          poetry install --all-extras
          poetry run pip install torch==2.0.1 --extra-index-url https://download.pytorch.org/whl/cpu
          poetry run 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