Go workflow (spacecloud-io/space-cloud)

The Go workflow from spacecloud-io/space-cloud, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: spacecloud-io/space-cloud.github/workflows/go.ymlLicense Apache-2.0View source

What it does

This is the Go workflow from the spacecloud-io/space-cloud 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

workflow (.yml)

name: Go
on: [push, pull_request]
jobs:
  gateway:
    name: Build and test gateway
    runs-on: ubuntu-latest
    steps:
      - name: Set up Go 1.15
        uses: actions/setup-go@v1
        with:
          go-version: 1.15
        id: go

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

      - name: Cache Go Modules
        uses: actions/cache@v1
        with:
          path: ~/go/pkg/mod
          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-

      - name: Build
        run: cd gateway && go build -v .
      - name: Test
        run: cd gateway && go test ./...
      - name: Lint
        run: |
          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.26.0
          sudo cp ./bin/golangci-lint $GOPATH/bin/
          cd gateway && golangci-lint run -E golint --exclude-use-default=false --timeout 600s ./...

  runner:
    name: Build and test Runner
    runs-on: ubuntu-latest
    steps:
      - name: Set up Go 1.15
        uses: actions/setup-go@v1
        with:
          go-version: 1.15
        id: go

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

      - name: Cache Go Modules
        uses: actions/cache@v1
        with:
          path: ~/go/pkg/mod
          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-

      - name: Build
        run: cd runner && go build -v .
      - name: Test
        run: cd runner && go test ./...
      - name: Lint
        run: |
          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.26.0
          sudo cp ./bin/golangci-lint $GOPATH/bin/
          cd runner && golangci-lint run -E golint --exclude-use-default=false --timeout 180s ./...

  cli:
    name: Build and test space cli
    runs-on: ubuntu-latest
    steps:
      - name: Set up Go 1.15
        uses: actions/setup-go@v1
        with:
          go-version: 1.15
        id: go
      - name: Check out code into the Go module directory
        uses: actions/checkout@v1
      - name: Cache Go Modules
        uses: actions/cache@v1
        with:
          path: ~/go/pkg/mod
          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-

      - name: Build
        run: cd space-cli && go build -v .
      - name: Test
        run: cd space-cli && go test ./...
      - name: Lint
        run: |
          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.26.0
          sudo cp ./bin/golangci-lint $GOPATH/bin/
          cd space-cli && golangci-lint run -E golint --exclude-use-default=false --timeout 180s ./...

The same workflow, on Latchkey

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

name: Go
on: [push, pull_request]
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  gateway:
    timeout-minutes: 30
    name: Build and test gateway
    runs-on: latchkey-small
    steps:
      - name: Set up Go 1.15
        uses: actions/setup-go@v1
        with:
          go-version: 1.15
        id: go
 
      - name: Check out code into the Go module directory
        uses: actions/checkout@v1
 
      - name: Cache Go Modules
        uses: actions/cache@v1
        with:
          path: ~/go/pkg/mod
          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-
 
      - name: Build
        run: cd gateway && go build -v .
      - name: Test
        run: cd gateway && go test ./...
      - name: Lint
        run: |
          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.26.0
          sudo cp ./bin/golangci-lint $GOPATH/bin/
          cd gateway && golangci-lint run -E golint --exclude-use-default=false --timeout 600s ./...
 
  runner:
    timeout-minutes: 30
    name: Build and test Runner
    runs-on: latchkey-small
    steps:
      - name: Set up Go 1.15
        uses: actions/setup-go@v1
        with:
          go-version: 1.15
        id: go
 
      - name: Check out code into the Go module directory
        uses: actions/checkout@v1
 
      - name: Cache Go Modules
        uses: actions/cache@v1
        with:
          path: ~/go/pkg/mod
          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-
 
      - name: Build
        run: cd runner && go build -v .
      - name: Test
        run: cd runner && go test ./...
      - name: Lint
        run: |
          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.26.0
          sudo cp ./bin/golangci-lint $GOPATH/bin/
          cd runner && golangci-lint run -E golint --exclude-use-default=false --timeout 180s ./...
 
  cli:
    timeout-minutes: 30
    name: Build and test space cli
    runs-on: latchkey-small
    steps:
      - name: Set up Go 1.15
        uses: actions/setup-go@v1
        with:
          go-version: 1.15
        id: go
      - name: Check out code into the Go module directory
        uses: actions/checkout@v1
      - name: Cache Go Modules
        uses: actions/cache@v1
        with:
          path: ~/go/pkg/mod
          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-go-
 
      - name: Build
        run: cd space-cli && go build -v .
      - name: Test
        run: cd space-cli && go test ./...
      - name: Lint
        run: |
          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.26.0
          sudo cp ./bin/golangci-lint $GOPATH/bin/
          cd space-cli && golangci-lint run -E golint --exclude-use-default=false --timeout 180s ./...

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.

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:

Network fetches

This workflow runs 3 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/setup-go actions/checkout actions/cache