Skip to main content

Go

This guide will help build Go projects on Semaphore.

Overview​

The Go toolchain is pre-installed in Linux machines. You can switch the active compiler using sem-version.

How to compile Go binaries​

You can compile a Go binary in a Linux job with:

checkout
go build -o my-app main.go

See artifacts to learn how to save and persist the built binary.

How to switch Go versions​

Use sem-version to switch between Go versions. This only works on Linux machines.

checkout
sem-version go 1.22
go version

Using Docker containers​

The sem-version tool does not work on Docker containers. You must use a pre-built Docker image with the language versions you need and run the job using Docker environments.

You can use the pre-build Go images or build your own. Find Dockerfiles to build your custom images in the semaphoreci/docker-images repository.

How to use GOPATH​

For Go versions 1.11 and below you have to prepare the GOPATH directory structure that Go expects. Run these commands before using Go in the CI environment if you're using Go 1.11 or lower:

GOPATH setup for Go 1.11 or lower
export "SEMAPHORE_GIT_DIR=$(go env GOPATH)/src/github.com/${SEMAPHORE_PROJECT_NAME}"
export "PATH=$(go env GOPATH)/bin:${PATH}"
mkdir -vp "${SEMAPHORE_GIT_DIR}" "$(go env GOPATH)/bin"

How to cache Go dependencies​

The cache tool automatically detects the presence of go.mod and caches all Go modules.

The first job in the pipeline must cache the dependencies:

checkout
cache restore
go get
cache store
go build

The rest of the jobs can use the cache directly:

checkout
cache restore
go build

How to set up test reports​

This section explains how to set up test reports (and flaky tests) for Go and GoTestSum.

  1. Install GoTestSum: go get gotest.tools/gotestsum

  2. Run GoTestSum with JUnit format output

    gotestsum --junitfile junit.xml ./...

  3. Follow Step 2 for every job in your pipeline that executes tests

  4. Create an after_pipeline job with the following command:

    test-results publish junit.xml
Example pipeline definition
Using test reports on Go
- name: Tests
  task:
    prologue:
      commands:
        - checkout
        - sem-version go 1.16
        - go get ./...

    job:
      name: "Tests"
      commands:
        - gotestsum --junitfile junit.xml ./...

    epilogue:
      always:
        commands:
          - test-results publish junit.xml