Pytest Tests workflow (citadel-ai/langcheck)
The Pytest Tests workflow from citadel-ai/langcheck, 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.
What it does
This is the Pytest Tests workflow from the citadel-ai/langcheck 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: Pytest Tests
# Controls when the workflow will run
on:
# Triggers the workflow on pull request events
pull_request:
# Triggers the workflow when a pull request merges into the main branch (this
# causes a `push` event). This is used for the test status badge in README.md
push:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "pytest"
pytest:
# The type of runner that the job will run on
runs-on: ubuntu-latest-4-cores
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks out this repository so this job can access it
- uses: actions/checkout@v4
# Use Python 3.10
- uses: actions/setup-python@v5
with:
python-version: '3.10'
# Install the langcheck package with dev dependencies
- name: Install
run: |
pip install --upgrade pip
pip install .[all,dev]
# Remove unneeded system libraries to maximize disk space
# https://github.com/easimon/maximize-build-space/blob/master/action.yml
# https://github.com/actions/virtual-environments/issues/2840#issuecomment-790492173
- name: Maximize disk space
run: |
echo "Available disk space (before):"
df -h
sudo rm -rf /usr/share/dotnet
sudo rm -rf /opt/ghc
sudo rm -rf /usr/local/lib/android
echo "Available disk space (after):"
df -h
# Run tests
- name: Test
run: |
python -m pytest -s -vv --durations=0 -m "not optional"
- name: Test (Optional)
run: |
python -m pytest -s -vv --durations=0 -m "optional"
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: Pytest Tests # Controls when the workflow will run on: # Triggers the workflow on pull request events pull_request: # Triggers the workflow when a pull request merges into the main branch (this # causes a `push` event). This is used for the test status badge in README.md push: branches: - main # Allows you to run this workflow manually from the Actions tab workflow_dispatch: # A workflow run is made up of one or more jobs that can run sequentially or in parallel concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: # This workflow contains a single job called "pytest" pytest: timeout-minutes: 30 # The type of runner that the job will run on runs-on: latchkey-small-4-cores # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks out this repository so this job can access it - uses: actions/checkout@v4 # Use Python 3.10 - uses: actions/setup-python@v5 with: cache: 'pip' python-version: '3.10' # Install the langcheck package with dev dependencies - name: Install run: | pip install --upgrade pip pip install .[all,dev] # Remove unneeded system libraries to maximize disk space # https://github.com/easimon/maximize-build-space/blob/master/action.yml # https://github.com/actions/virtual-environments/issues/2840#issuecomment-790492173 - name: Maximize disk space run: | echo "Available disk space (before):" df -h sudo rm -rf /usr/share/dotnet sudo rm -rf /opt/ghc sudo rm -rf /usr/local/lib/android echo "Available disk space (after):" df -h # Run tests - name: Test run: | python -m pytest -s -vv --durations=0 -m "not optional" - name: Test (Optional) run: | python -m pytest -s -vv --durations=0 -m "optional"
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.
- 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.