Code formatting workflow (ag2ai/build-with-ag2)

The Code formatting workflow from ag2ai/build-with-ag2, explained and optimized by Latchkey.

What it does

This is the Code formatting workflow from the ag2ai/build-with-ag2 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: Code formatting

# see: https://help.github.com/en/actions/reference/events-that-trigger-workflows
on:  # Trigger the workflow on pull request or merge
  pull_request:
  merge_group:
    types: [checks_requested]

defaults:
  run:
    shell: bash
permissions: {}
    # actions: read
  # checks: read
  # contents: read
  # deployments: read
jobs:

  pre-commit-check:
    runs-on: ubuntu-latest
    env:
      SKIP: "mypy"
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
      - name: Set $PY environment variable
        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
      - uses: actions/cache@v4
        with:
          path: ~/.cache/pre-commit
          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
      - uses: pre-commit/action@v3.0.1

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 formatting
 
# see: https://help.github.com/en/actions/reference/events-that-trigger-workflows
on:  # Trigger the workflow on pull request or merge
  pull_request:
  merge_group:
    types: [checks_requested]
 
defaults:
  run:
    shell: bash
permissions: {}
    # actions: read
  # checks: read
  # contents: read
  # deployments: read
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
 
  pre-commit-check:
    timeout-minutes: 30
    runs-on: latchkey-small
    env:
      SKIP: "mypy"
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
      - name: Set $PY environment variable
        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
      - uses: actions/cache@v4
        with:
          path: ~/.cache/pre-commit
          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
      - uses: pre-commit/action@v3.0.1
 

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.

1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

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