Check formatting workflow (brentvollebregt/auto-py-to-exe)

The Check formatting workflow from brentvollebregt/auto-py-to-exe, explained and optimized by Latchkey.

What it does

This is the Check formatting workflow from the brentvollebregt/auto-py-to-exe 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: Check formatting

on:
  push:
  pull_request:

jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Check Ruff linting
        uses: astral-sh/ruff-action@v3
        with:
          args: 'check'

      - name: Check Ruff formatting
        if: success() || failure()
        uses: astral-sh/ruff-action@v3
        with:
          args: 'format --check'

      - name: Check Prettier formatting
        if: success() || failure()
        uses: creyD/prettier_action@v4.5 # This can be bumped when https://github.com/creyD/prettier_action/issues/154 is solved
        with:
          prettier_version: '2.8.8'
          dry: true
          prettier_options: '--check .'

  translations:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-node@v6

      - name: Run check-translations.js
        run: node check-translations.js >> $GITHUB_STEP_SUMMARY
        working-directory: ./.github/workflow_utils

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: Check formatting
 
on:
  push:
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  main:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v6
 
      - name: Check Ruff linting
        uses: astral-sh/ruff-action@v3
        with:
          args: 'check'
 
      - name: Check Ruff formatting
        if: success() || failure()
        uses: astral-sh/ruff-action@v3
        with:
          args: 'format --check'
 
      - name: Check Prettier formatting
        if: success() || failure()
        uses: creyD/prettier_action@v4.5 # This can be bumped when https://github.com/creyD/prettier_action/issues/154 is solved
        with:
          prettier_version: '2.8.8'
          dry: true
          prettier_options: '--check .'
 
  translations:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v6
 
      - uses: actions/setup-node@v6
        with:
          cache: 'npm'
 
      - name: Run check-translations.js
        run: node check-translations.js >> $GITHUB_STEP_SUMMARY
        working-directory: ./.github/workflow_utils
 

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.

2 third-party actions are referenced by a movable tag. Pin them to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

This workflow runs 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow