Format workflow (ProjectQ-Framework/ProjectQ)

The Format workflow from ProjectQ-Framework/ProjectQ, explained and optimized by Latchkey.

What it does

This is the Format workflow from the ProjectQ-Framework/ProjectQ 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: Format

on:
  workflow_dispatch:
  merge_group:
  pull_request:
  push:
    branches:
      - master
      - stable
      - "v*"

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true


jobs:
  clang-tidy:
    name: Clang-Tidy
    runs-on: ubuntu-latest
    container: silkeh/clang:14
    env:
      CC: clang
      CXX: clang++

    steps:
      - uses: actions/checkout@v3

      - name: Prepare env
        run: >
          apt-get update && apt-get install -y python3-dev python3-pip python3-setuptools python3-wheel
          --no-install-recommends

      - name: Upgrade pybind11 and setuptools
        run: python3 -m pip install --upgrade pybind11 "setuptools>=61.0.0" --prefer-binary

      - name: Run clang-tidy
        run: python3 setup.py clang_tidy --warning-as-errors

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

---
 
name: Format
 
on:
  workflow_dispatch:
  merge_group:
  pull_request:
  push:
    branches:
      - master
      - stable
      - "v*"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
 
jobs:
  clang-tidy:
    timeout-minutes: 30
    name: Clang-Tidy
    runs-on: latchkey-small
    container: silkeh/clang:14
    env:
      CC: clang
      CXX: clang++
 
    steps:
      - uses: actions/checkout@v3
 
      - name: Prepare env
        run: >
          apt-get update && apt-get install -y python3-dev python3-pip python3-setuptools python3-wheel
          --no-install-recommends
 
      - name: Upgrade pybind11 and setuptools
        run: python3 -m pip install --upgrade pybind11 "setuptools>=61.0.0" --prefer-binary
 
      - name: Run clang-tidy
        run: python3 setup.py clang_tidy --warning-as-errors
 

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.
• 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