Python Code Format Tests workflow (citadel-ai/langcheck)

The Python Code Format Tests workflow from citadel-ai/langcheck, explained and optimized by Latchkey.

What it does

This is the Python Code Format 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: Python Code Format Tests

# Controls when the workflow will run
on:
  # Triggers the workflow on pull request events
  pull_request:

  # 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 "format"
  format:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # 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@v2

      # Use Python 3.10
      - uses: actions/setup-python@v4
        with:
          python-version: '3.10'

      # Install the langcheck package with dev dependencies
      - name: Install
        run: |
          pip install -U --upgrade pip
          pip install -U .[all,dev]

      # Run the ruff lint
      - name: Ruff check
        run: ruff check --output-format=github src/ tests/

      # Run the ruff format
      - name: Ruff format
        run: ruff format --check src/ tests/

      # Run the pyright test
      - name: Pyright
        run: pyright .

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: Python Code Format Tests
 
# Controls when the workflow will run
on:
  # Triggers the workflow on pull request events
  pull_request:
 
  # 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 "format"
  format:
    timeout-minutes: 30
    # The type of runner that the job will run on
    runs-on: latchkey-small
 
    # 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@v2
 
      # Use Python 3.10
      - uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: '3.10'
 
      # Install the langcheck package with dev dependencies
      - name: Install
        run: |
          pip install -U --upgrade pip
          pip install -U .[all,dev]
 
      # Run the ruff lint
      - name: Ruff check
        run: ruff check --output-format=github src/ tests/
 
      # Run the ruff format
      - name: Ruff format
        run: ruff format --check src/ tests/
 
      # Run the pyright test
      - name: Pyright
        run: pyright .
 

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