auto-queue workflow (cdk8s-team/cdk8s)

The auto-queue workflow from cdk8s-team/cdk8s, explained and optimized by Latchkey.

What it does

This is the auto-queue workflow from the cdk8s-team/cdk8s 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

# ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen".

name: auto-queue
on:
  pull_request_target:
    types:
      - opened
      - reopened
      - ready_for_review
jobs:
  enableAutoQueue:
    name: "Set AutoQueue on PR #${{ github.event.number }}"
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
      contents: write
    steps:
      - uses: peter-evans/enable-pull-request-automerge@v3
        with:
          token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
          pull-request-number: ${{ github.event.number }}
          merge-method: squash

The same workflow, on Latchkey

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

# ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen".
 
name: auto-queue
on:
  pull_request_target:
    types:
      - opened
      - reopened
      - ready_for_review
jobs:
  enableAutoQueue:
    timeout-minutes: 30
    name: "Set AutoQueue on PR #${{ github.event.number }}"
    runs-on: latchkey-small
    permissions:
      pull-requests: write
      contents: write
    steps:
      - uses: peter-evans/enable-pull-request-automerge@v3
        with:
          token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
          pull-request-number: ${{ github.event.number }}
          merge-method: squash
 

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.

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.