Code Style Check workflow (httpie/httpie)

The Code Style Check workflow from httpie/httpie, explained and optimized by Latchkey.

What it does

This is the Code Style Check workflow from the httpie/httpie 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: Code Style Check

on:
  pull_request:
    paths:
      - .github/workflows/code-style.yml
      - extras/*.py
      - httpie/**/*.py
      - setup.py
      - tests/**/*.py

jobs:
  code-style:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: 3.9
      - run: make venv
      - run: make codestyle

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: Code Style Check
 
on:
  pull_request:
    paths:
      - .github/workflows/code-style.yml
      - extras/*.py
      - httpie/**/*.py
      - setup.py
      - tests/**/*.py
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  code-style:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: 3.9
      - run: make venv
      - run: make codestyle
 

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.

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