Test workflow (protocolbuffers/protobuf-go)

C

CI health grade

69/100

Health score

1

Job per trigger

3

Fixes in the optimized version

What it does

This is the Test workflow from the protocolbuffers/protobuf-go repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

on: [push]
name: Test
jobs:
  test:
    strategy:
      matrix:
        # This is just a version to compile the integration_test.go; see
        # golangVersions in that file for the list of actual Go versions used.
        go-version: [1.x]
        os: [ubuntu-latest] # TODO: Add [macos-latest, windows-latest]
    runs-on: ${{ matrix.os }}
    steps:
    - name: Install Linux dependencies
      if: runner.os == 'Linux'
      run: sudo apt-get -y install autoconf automake libtool curl make g++ unzip
    - name: Checkout code
      uses: actions/checkout@v3
    - name: Install Go
      uses: actions/setup-go@v4
      with:
        go-version: ${{ matrix.go-version }}
    - name: Cache dependencies
      uses: actions/cache@v3
      with:
        path: |
          .cache
          ~/.cache/bazel
        key: ${{ runner.os }}-${{ hashFiles('integration_test.go') }}
    - name: Test
      env:
        # Protobuf 30 does not yet support anything newer than Bazel 7
        USE_BAZEL_VERSION: 7.x
      run: go test -run='^TestIntegration$' -v -timeout=60m -count=1 -failfast "$@"

The same workflow, on Latchkey

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

on: [push]
name: Test
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  test:
    timeout-minutes: 30
    strategy:
      matrix:
        # This is just a version to compile the integration_test.go; see
        # golangVersions in that file for the list of actual Go versions used.
        go-version: [1.x]
        os: [ubuntu-latest] # TODO: Add [macos-latest, windows-latest]
    runs-on: ${{ matrix.os }}
    runs-on: latchkey-small
    steps:
    - name: Install Linux dependencies
      if: runner.os == 'Linux'
      run: sudo apt-get -y install autoconf automake libtool curl make g++ unzip
    - name: Checkout code
      uses: actions/checkout@v3
    - name: Install Go
      uses: actions/setup-go@v4
      with:
        go-version: ${{ matrix.go-version }}
    - name: Cache dependencies
      uses: actions/cache@v3
      with:
        path: |
          .cache
          ~/.cache/bazel
        key: ${{ runner.os }}-${{ hashFiles('integration_test.go') }}
    - name: Test
      env:
        # Protobuf 30 does not yet support anything newer than Bazel 7
        USE_BAZEL_VERSION: 7.x
      run: go test -run='^TestIntegration$' -v -timeout=60m -count=1 -failfast "$@"

What changed

1. Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. Each Linux x64 job moves to the Latchkey size matching its vCPU count, latchkey-small for a standard 2 vCPU runner; macOS, Windows and arm64 jobs stay as written.
2. Cancel superseded runs when a branch or PR gets a newer push.
3. 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
• Network fetches

This workflow runs 1 job per trigger. It runs on a standard GitHub-hosted Linux x64 runner, which in a private repository bills $0.006 a minute against $0.0025 on latchkey-small, 58% lower; in a public repository like this one it is free. Estimate the monthly difference with your own run counts.

Actions used in this workflow

• actions/checkout
• actions/setup-go
• actions/cache

Frequently asked questions

References

• Go documentation
• GitHub Actions documentation