property-tests workflow (pyranges/pyranges0)

The property-tests workflow from pyranges/pyranges0, explained and optimized by Latchkey.

What it does

This is the property-tests workflow from the pyranges/pyranges0 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

name: property-tests

on:
  workflow_run:
    workflows: [linting-typechecking-doctests]
    types: [completed]


jobs:
  on-success:
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: "3.11.0"
      - run: sudo apt-get install bedtools
      - run: pip install hypothesis pytest pytest-xdist
      - run: pip install .
      - run: pytest -sv -n 2 tests/property_based
        env:
          GITHUB_ACTIONS: true
  on-failure:
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
    steps:
      - run: exit 1  # Fail the job

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: property-tests
 
on:
  workflow_run:
    workflows: [linting-typechecking-doctests]
    types: [completed]
 
 
jobs:
  on-success:
    timeout-minutes: 30
    runs-on: latchkey-small
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: "3.11.0"
      - run: sudo apt-get install bedtools
      - run: pip install hypothesis pytest pytest-xdist
      - run: pip install .
      - run: pytest -sv -n 2 tests/property_based
        env:
          GITHUB_ACTIONS: true
  on-failure:
    timeout-minutes: 30
    runs-on: latchkey-small
    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
    steps:
      - run: exit 1  # Fail the job
 

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.
• 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 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow