Validate Black Formatting workflow (calico/borzoi)

The Validate Black Formatting workflow from calico/borzoi, explained and optimized by Latchkey.

What it does

This is the Validate Black Formatting workflow from the calico/borzoi repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

name: Validate Black Formatting

on:
  workflow_dispatch:
  push:
    paths:
      - "**.py"

jobs:
  format:
    runs-on: ubuntu-20.04

    steps:
      - name: Checkout base repo
        uses: actions/checkout@v3

      - name: Set up Python 3.11
        uses: actions/setup-python@v2
        with:
          python-version: "3.11"

      - name: Install dependencies
        run: python3 -m pip install black~=22.3.0

      - name: Check Black formatting
        run: black --check .

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: Validate Black Formatting
 
on:
  workflow_dispatch:
  push:
    paths:
      - "**.py"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  format:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
      - name: Checkout base repo
        uses: actions/checkout@v3
 
      - name: Set up Python 3.11
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: "3.11"
 
      - name: Install dependencies
        run: python3 -m pip install black~=22.3.0
 
      - name: Check Black formatting
        run: black --check .
 

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