Tests workflow (OML-Team/open-metric-learning)

The Tests workflow from OML-Team/open-metric-learning, explained and optimized by Latchkey.

CI health: C - fair

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

Grade your own workflow free or run it on Latchkey →

Source: OML-Team/open-metric-learning.github/workflows/tests.yamlLicense Apache-2.0View source

What it does

This is the Tests workflow from the OML-Team/open-metric-learning repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

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

The workflow

workflow (.yml)

name: Tests

on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main

jobs:
  short_tests:
    runs-on: ubuntu-24.04
    if: github.event_name == 'pull_request'
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"]
    timeout-minutes: 30
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Installation
      run: |
        python3 -m pip install --upgrade pip
        python3 -m pip install -e ".[pipelines,test]" --extra-index-url https://download.pytorch.org/whl/cpu
    - name: Running short tests
      run: |
        make run_short_tests

  all_tests:
    runs-on: ubuntu-24.04
    if: github.event_name == 'push'
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"]
    timeout-minutes: 60
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Installation
      run: |
        python3 -m pip install --upgrade pip
        python3 -m pip install -e ".[all,test]" --extra-index-url https://download.pytorch.org/whl/cpu
    - name: Running all tests
      run: |
        if [ "${{ matrix.python-version }}" == "3.10" ]; then
          make run_all_tests WANDB_API_KEY=${{ secrets.WANDB_API_KEY }} NEPTUNE_API_TOKEN=${{ secrets.NEPTUNE_API_TOKEN }} DOWNLOAD_ZOO_IN_TESTS=yes TEST_CLOUD_LOGGERS=yes
        else
          make run_all_tests WANDB_API_KEY=${{ secrets.WANDB_API_KEY }} NEPTUNE_API_TOKEN=${{ secrets.NEPTUNE_API_TOKEN }}
        fi

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.

name: Tests
 
on:
  pull_request:
    branches:
      - main
  push:
    branches:
      - main
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  short_tests:
    runs-on: latchkey-small
    if: github.event_name == 'pull_request'
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"]
    timeout-minutes: 30
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Installation
      run: |
        python3 -m pip install --upgrade pip
        python3 -m pip install -e ".[pipelines,test]" --extra-index-url https://download.pytorch.org/whl/cpu
    - name: Running short tests
      run: |
        make run_short_tests
 
  all_tests:
    runs-on: latchkey-small
    if: github.event_name == 'push'
    strategy:
      matrix:
        python-version: ["3.10", "3.11", "3.12"]
    timeout-minutes: 60
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Installation
      run: |
        python3 -m pip install --upgrade pip
        python3 -m pip install -e ".[all,test]" --extra-index-url https://download.pytorch.org/whl/cpu
    - name: Running all tests
      run: |
        if [ "${{ matrix.python-version }}" == "3.10" ]; then
          make run_all_tests WANDB_API_KEY=${{ secrets.WANDB_API_KEY }} NEPTUNE_API_TOKEN=${{ secrets.NEPTUNE_API_TOKEN }} DOWNLOAD_ZOO_IN_TESTS=yes TEST_CLOUD_LOGGERS=yes
        else
          make run_all_tests WANDB_API_KEY=${{ secrets.WANDB_API_KEY }} NEPTUNE_API_TOKEN=${{ secrets.NEPTUNE_API_TOKEN }}
        fi

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.

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 2 jobs (6 with the matrix expanded) 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