golang-buildkite-plugin's Introduction

Golang Buildkite Plugin

This used to be the home of the GOPATH Checkout Buildkite Plugin. If you've received "Failed to checkout plugin golang" errors (#1), please update your pipeline.yml plugin name from golang to gopath-checkout.

A Buildkite plugin for running a command in a docker container with a specific golang version.

The build directory is mounted into the docker container, so artifact uploads work.

Example

You can run go commands against a specific version.

steps:
  - command: go test ./...
    plugins:
      - golang#v2.0.0:
          version: 1.13.8
          import: github.com/buildkite/agent

You can pass in additional environment variables:

steps:
  - command: go build .
    plugins:
      - golang#v2.0.0:
          version: 1.13.8
          import: github.com/buildkite/agent
          environment:
            - GOOS=darwin
            - GOARCH=amd64

Configuration

`version` (required)

The golang docker image to use. See https://hub.docker.com/_/golang/ for a full list.

Example: 1.10.2

`import`(required)

The golang package to use in the gopath in the container.

Exmaple: github.com/buildkite/agent

`environment` (optional)

Extra environment variables to pass to the docker container, in an array. Items can be specified as either KEY or KEY=value. Each entry corresponds to a Docker CLI --env parameter. Values specified as variable names will be passed through from the outer environment.

Examples: MY_SECRET_KEY, MY_SPECIAL_BUT_PUBLIC_VALUE=kittens

See https://golang.org/doc/install/source#environment for all the possible values that the golang binary respects.