Python Test on Pull Requests workflow (keleshev/schema)

The Python Test on Pull Requests workflow from keleshev/schema, explained and optimized by Latchkey.

What it does

This is the Python Test on Pull Requests workflow from the keleshev/schema 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: Python Test on Pull Requests

on:
    pull_request:
        branches:
          - master

jobs:
  build-and-test:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository
      uses: actions/checkout@v2

    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.10'

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pytest mypy
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

    - name: Run tests
      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.

name: Python Test on Pull Requests
 
on:
    pull_request:
        branches:
          - master
 
concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true
 
jobs:
  build-and-test:
    runs-on: latchkey-small
 
    steps:
    - name: Check out repository
      uses: actions/checkout@v2
 
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
          cache: 'pip'
        python-version: '3.10'
 
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pytest mypy
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
 
    - name: Run tests
      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.

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