Tests and Linting workflow (serengil/chefboost)

The Tests and Linting workflow from serengil/chefboost, 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.

Grade your own workflow free or run it on Latchkey →

Source: serengil/chefboost.github/workflows/tests.ymlLicense MITView source

What it does

This is the Tests and Linting workflow from the serengil/chefboost 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

workflow (.yml)

name: Tests and Linting

on: 
  push:
    paths:
      - '.github/workflows/tests.yml'
      - 'chefboost/**'  
      - 'tests/**'
      - 'requirements.txt'
      - '.gitignore'
      - 'setup.py'
  pull_request:
    paths:
      - '.github/workflows/tests.yml'
      - 'chefboost/**'  
      - 'tests/**'
      - 'requirements.txt'
      - '.gitignore'
      - 'setup.py'

jobs:
  unit-tests:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.9]

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pytest
        pip install .
        
    - name: Test with pytest
      run: |
        cd tests
        python -m pytest . -s --disable-warnings
  linting:
    needs: unit-tests
    
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.9]
  
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pylint==3.0.2
        pip install black
        pip install .
        
    - name: Lint with pylint
      run: |
        python -m pylint chefboost/ --fail-under=10

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 and Linting
 
on: 
  push:
    paths:
      - '.github/workflows/tests.yml'
      - 'chefboost/**'  
      - 'tests/**'
      - 'requirements.txt'
      - '.gitignore'
      - 'setup.py'
  pull_request:
    paths:
      - '.github/workflows/tests.yml'
      - 'chefboost/**'  
      - 'tests/**'
      - 'requirements.txt'
      - '.gitignore'
      - 'setup.py'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  unit-tests:
    timeout-minutes: 30
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: [3.9]
 
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pytest
        pip install .
        
    - name: Test with pytest
      run: |
        cd tests
        python -m pytest . -s --disable-warnings
  linting:
    timeout-minutes: 30
    needs: unit-tests
    
    runs-on: latchkey-small
    strategy:
      matrix:
        python-version: [3.9]
  
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        cache: 'pip'
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pylint==3.0.2
        pip install black
        pip install .
        
    - name: Lint with pylint
      run: |
        python -m pylint chefboost/ --fail-under=10

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.
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

actions/checkout actions/setup-python