Go workflow (TarsCloud/TarsGo)

The Go workflow from TarsCloud/TarsGo, explained and optimized by Latchkey.

What it does

This is the Go workflow from the TarsCloud/TarsGo 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

name: Go

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    name: build & test
    runs-on: ubuntu-latest

    steps:
      - name: Set up Go 1.x
        uses: actions/setup-go@v2
        with:
          go-version: ^1.16
        id: go

      - name: Check out code into the Go module directory
        uses: actions/checkout@v2

      - name: tars2go
        run: |
          cd tars/tools/tars2go
          go build ./...
          go test ./...

      - name: tarsgo
        run: |
          cd tars/tools/tarsgo
          go build ./...
          go test ./...

      - name: Build
        run: |
          go mod tidy
          go build ./tars

      - name: Codecov
        uses: codecov/codecov-action@v2

The same workflow, on Latchkey

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

name: Go
 
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    name: build & test
    runs-on: latchkey-small
 
    steps:
      - name: Set up Go 1.x
        uses: actions/setup-go@v2
        with:
          go-version: ^1.16
        id: go
 
      - name: Check out code into the Go module directory
        uses: actions/checkout@v2
 
      - name: tars2go
        run: |
          cd tars/tools/tars2go
          go build ./...
          go test ./...
 
      - name: tarsgo
        run: |
          cd tars/tools/tarsgo
          go build ./...
          go test ./...
 
      - name: Build
        run: |
          go mod tidy
          go build ./tars
 
      - name: Codecov
        uses: codecov/codecov-action@v2
 

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