pre-commit-check workflow (pykale/pykale)

The pre-commit-check workflow from pykale/pykale, explained and optimized by Latchkey.

What it does

This is the pre-commit-check workflow from the pykale/pykale 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

# This workflow will run lint and many other pre-commit hooks.
# https://pre-commit.com/

name: pre-commit-check

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  pre-commit-check:
    name: Pre-commit checks including linting
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.11"
      - name: Install dependencies
        run: |
          pip install pre-commit isort
          pre-commit install
      - name: Run pre-commit checks including linting
        run: |
          pre-commit run --all-files

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.

# This workflow will run lint and many other pre-commit hooks.
# https://pre-commit.com/
 
name: pre-commit-check
 
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  pre-commit-check:
    timeout-minutes: 30
    name: Pre-commit checks including linting
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          cache: 'pip'
          python-version: "3.11"
      - name: Install dependencies
        run: |
          pip install pre-commit isort
          pre-commit install
      - name: Run pre-commit checks including linting
        run: |
          pre-commit run --all-files
 

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