Benchmark workflow (django/django)
The Benchmark workflow from django/django, explained and optimized by Latchkey.
CI health: A - excellent
Point runs-on at Latchkey and get run de-duplication, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the Benchmark workflow from the django/django repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
name: Benchmark
on:
pull_request:
types: [ labeled, synchronize, opened, reopened ]
permissions:
contents: read
jobs:
Run_benchmarks:
if: contains(github.event.pull_request.labels.*.name, 'benchmark')
runs-on: ubuntu-latest
timeout-minutes: 60
steps:
- name: Checkout Benchmark Repo
uses: actions/checkout@v7
with:
repository: django/django-asv
path: "."
persist-credentials: false
- name: Setup Miniforge
# Pinned to v3.2.0.
uses: conda-incubator/setup-miniconda@835234971496cad1653abb28a638a281cf32541f
with:
miniforge-version: "24.1.2-0"
activate-environment: asv-bench
- name: Install Requirements
run: pip install -r requirements.txt
- name: Cache Django
uses: actions/cache@v6
with:
path: Django/*
key: Django
- name: Run Benchmarks
shell: bash -l {0}
run: |-
asv machine --machine ubuntu-latest --yes > /dev/null
echo 'Beginning benchmarks...'
asv continuous --interleave-processes -a processes=2 --split --show-stderr 'HEAD^' 'HEAD' |\
sed -n -E '/(before.*after.*ratio)|(BENCHMARKS)/,$p' >> out.txt
echo 'Benchmarks Done.'
echo '```' >> $GITHUB_STEP_SUMMARY
cat out.txt >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
if grep -q "PERFORMANCE DECREASED" out.txt;
then
exit 1
fi
The same workflow, on Latchkey
Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.
name: Benchmark on: pull_request: types: [ labeled, synchronize, opened, reopened ] permissions: contents: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: Run_benchmarks: if: contains(github.event.pull_request.labels.*.name, 'benchmark') runs-on: latchkey-small timeout-minutes: 60 steps: - name: Checkout Benchmark Repo uses: actions/checkout@v7 with: repository: django/django-asv path: "." persist-credentials: false - name: Setup Miniforge # Pinned to v3.2.0. uses: conda-incubator/setup-miniconda@835234971496cad1653abb28a638a281cf32541f with: miniforge-version: "24.1.2-0" activate-environment: asv-bench - name: Install Requirements run: pip install -r requirements.txt - name: Cache Django uses: actions/cache@v6 with: path: Django/* key: Django - name: Run Benchmarks shell: bash -l {0} run: |- asv machine --machine ubuntu-latest --yes > /dev/null echo 'Beginning benchmarks...' asv continuous --interleave-processes -a processes=2 --split --show-stderr 'HEAD^' 'HEAD' |\ sed -n -E '/(before.*after.*ratio)|(BENCHMARKS)/,$p' >> out.txt echo 'Benchmarks Done.' echo '```' >> $GITHUB_STEP_SUMMARY cat out.txt >> $GITHUB_STEP_SUMMARY echo '```' >> $GITHUB_STEP_SUMMARY if grep -q "PERFORMANCE DECREASED" out.txt; then exit 1 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 useslatchkey-small; pick the runner size that fits the job. - Cancel superseded runs when a branch or PR gets a newer push.
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.