build workflow (roo-oliv/injectable)

The build workflow from roo-oliv/injectable, explained and optimized by Latchkey.

CI health: D - needs work

Run this on Latchkey for self-healing, caching, and up to 58% lower cost.

Grade your own workflow free or run it on Latchkey →

Source: roo-oliv/injectable.github/workflows/build.ymlLicense MITView source

What it does

This is the build workflow from the roo-oliv/injectable 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: build

on: push

jobs:
  tests:
    runs-on: ${{ matrix.os }}
    strategy:
      max-parallel: 4
      matrix:
        os: [ubuntu-latest, windows-latest, macOS-latest]
        python-version: ["3.9", "3.10", "3.11", "3.12"]

    steps:
    - uses: actions/checkout@v2
    - 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
        make requirements
    - name: Check code style with Black
      run: |
        make black-check
    - name: Check code standards with Flake8
      run: |
        make flake-check
    - name: Run tests with pytest
      run: |
        make tests
    - name: Export coverage to Coveralls
      if: success() && github.ref == 'refs/heads/master' && matrix.os == 'ubuntu-latest'
      run: |
        coveralls
      env:
        CI_NAME: GitHub Actions
        CI_BRANCH: master
        COVERALLS_REPO_TOKEN: ${{ secrets.coveralls_repo_token }}

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: build
 
on: push
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  tests:
    timeout-minutes: 30
    runs-on: ${{ matrix.os }}
    strategy:
      max-parallel: 4
      matrix:
        os: [ubuntu-latest, windows-latest, macOS-latest]
        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
    steps:
    - uses: actions/checkout@v2
    - 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
        make requirements
    - name: Check code style with Black
      run: |
        make black-check
    - name: Check code standards with Flake8
      run: |
        make flake-check
    - name: Run tests with pytest
      run: |
        make tests
    - name: Export coverage to Coveralls
      if: success() && github.ref == 'refs/heads/master' && matrix.os == 'ubuntu-latest'
      run: |
        coveralls
      env:
        CI_NAME: GitHub Actions
        CI_BRANCH: master
        COVERALLS_REPO_TOKEN: ${{ secrets.coveralls_repo_token }}

What changed

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 (12 with the matrix expanded) 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