Library tests workflow (IBM/differential-privacy-library)

The Library tests workflow from IBM/differential-privacy-library, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: IBM/differential-privacy-library.github/workflows/libraries.ymlLicense MITView source

What it does

This is the Library tests workflow from the IBM/differential-privacy-library repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

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

name: Library tests

on:
  workflow_dispatch:
  push:
    branches: ['**']
  pull_request:
    branches: [ main ]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      fail-fast: false

      matrix:
        include:
          - library: numpy
            version: 2.0.2
            python-version: '3.11'
          - library: numpy
            version: 2.1.3
            python-version: '3.11'

          - library: scikit-learn
            version: 1.4.2
            python-version: '3.11'
          - library: scikit-learn
            version: 1.5.2
            python-version: '3.12'

          - library: scipy
            version: 1.13.1
            python-version: '3.11'
          - library: scipy
            version: 1.14.1
            python-version: '3.11'

          - library: crlibm
            python-version: '3.10'

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install pytest
        python -m pip install .

    - name: Pre-install numpy
      if: ${{ matrix.library == 'numpy' }}
      run: |
        python -m pip install numpy==${{ matrix.version }}

    - name: Pre-install scikit-learn
      if: ${{ matrix.library == 'scikit-learn' }}
      run: |
        python -m pip install scikit-learn==${{ matrix.version }}

    - name: Pre-install scipy
      if: ${{ matrix.library == 'scipy' }}
      run: |
        python -m pip install scipy==${{ matrix.version }}

    - name: Pre-install crlibm
      if: ${{ matrix.library == 'crlibm' }}
      run: |
        python -m pip install setuptools==60.2.0 wheel==0.37.1
        python -m pip install crlibm

    - name: List installed packages
      run: |
        python -m pip list
    - name: Test with pytest
      run: |
        pytest

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
name: Library tests
 
on:
  workflow_dispatch:
  push:
    branches: ['**']
  pull_request:
    branches: [ main ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: latchkey-small
    strategy:
      fail-fast: false
 
      matrix:
        include:
          - library: numpy
            version: 2.0.2
            python-version: '3.11'
          - library: numpy
            version: 2.1.3
            python-version: '3.11'
 
          - library: scikit-learn
            version: 1.4.2
            python-version: '3.11'
          - library: scikit-learn
            version: 1.5.2
            python-version: '3.12'
 
          - library: scipy
            version: 1.13.1
            python-version: '3.11'
          - library: scipy
            version: 1.14.1
            python-version: '3.11'
 
          - library: crlibm
            python-version: '3.10'
 
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install pytest
        python -m pip install .
 
    - name: Pre-install numpy
      if: ${{ matrix.library == 'numpy' }}
      run: |
        python -m pip install numpy==${{ matrix.version }}
 
    - name: Pre-install scikit-learn
      if: ${{ matrix.library == 'scikit-learn' }}
      run: |
        python -m pip install scikit-learn==${{ matrix.version }}
 
    - name: Pre-install scipy
      if: ${{ matrix.library == 'scipy' }}
      run: |
        python -m pip install scipy==${{ matrix.version }}
 
    - name: Pre-install crlibm
      if: ${{ matrix.library == 'crlibm' }}
      run: |
        python -m pip install setuptools==60.2.0 wheel==0.37.1
        python -m pip install crlibm
 
    - name: List installed packages
      run: |
        python -m pip list
    - name: Test with pytest
      run: |
        pytest

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
Cancel superseded runs when a branch or PR gets a newer push.
Cache dependency installs on the setup step so they are served from cache.
Add a job timeout so a hung step cannot burn hours of runner time.

What Latchkey heals here

This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:

Dependency installs

This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-python