https://github.com/function61/buildkit-golang

Frequently needed tools for building Go-based projects. Internally runs just the regular `$ go build` but also runs tests, lint etc.
https://github.com/function61/buildkit-golang

Last synced: about 1 month ago
JSON representation

Frequently needed tools for building Go-based projects. Internally runs just the regular `$ go build` but also runs tests, lint etc.

• Host: GitHub
• URL: https://github.com/function61/buildkit-golang
• Owner: function61
• License: apache-2.0
• Created: 2018-08-29T14:10:10.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2025-11-24T14:06:08.000Z (4 months ago)
• Last Synced: 2025-11-28T01:57:39.508Z (4 months ago)
• Language: Shell
• Homepage: https://function61.com/
• Size: 275 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Build status](https://github.com/function61/buildkit-golang/workflows/Build/badge.svg)

[![Download](https://img.shields.io/docker/pulls/fn61/buildkit-golang.svg?style=for-the-badge)](https://hub.docker.com/r/fn61/buildkit-golang/)

Golang buildkit with shared low-level tools / build process required for Go projects of some quality.

See [Turbo Bob](https://github.com/function61/turbobob) for more details.

![](docs/logo.webp)

How to use

----------

[build-go-project.sh](build-go-project.sh) is available inside the container image.

Our typical projects declare the `build-go-project.sh` call in the build command definition in

[turbobob.json](https://github.com/function61/turbobob/blob/51e6c7f5c5b0e7b0c244d670410e6c1a383429a6/turbobob.json#L11).

Cross compilation is done depending on ENV variables. E.g. to build for `Linux/ARM` you should have

`BUILD_LINUX_ARM=true` set. These are handled automatically if you use Turbo Bob.

Features

--------

- Go build environment

- Contains [goimports](https://pkg.go.dev/golang.org/x/tools/cmd/goimports) which is like `gofmt`

  for your imports - it can sometimes even automatically add missing imports!

- Contains [gopls](https://github.com/golang/tools/blob/master/gopls/README.md), a Go

  [language server](https://langserver.org/). Works in a container without changes to one's host system!

	* Working is somewhat tied to use with Turbo Bob (LSP working inside container needs a few tricks)

- Contains [Gohack](https://github.com/rogpeppe/gohack) to make editing dependency modules easy

- [Govulncheck](https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck) reports known vulnerabilities that affect Go code.

- Fully static builds (so works even on Alpine linux which doesn't have standard libc)

- Cross compilation support:

	* Linux-amd64

	* Linux-arm

	* Windows-amd64

	* macOS-amd64

- [Protobuf](https://developers.google.com/protocol-buffers) compiler included

- [Deployer](https://github.com/function61/deployer) integration

	* For packaging `deployerspec.zip` files

- [doc2go](https://github.com/abhinav/doc2go/) for generating documentation (use case: private documentation). See [why godoc isn't enough](https://github.com/golang/go/issues/2381).

Standardized build process:

- Passes build version to your code

	* Using [gokit/app/dynversion](https://pkg.go.dev/github.com/function61/gokit/app/dynversion)

- Runs static analysis

	* Uses [golangci-lint](https://github.com/golangci/golangci-lint)

	  (does what `$ go vet` does + much more)

- Runs your unit tests (`$ go test`)

	* With race detector enabled

- Fetches your dependencies using Go modules

- Automatically rejects Go code that is not `$ go fmt`'d

- Runs any code generators you might have

	* Runs `$ go generate ./...`

- Helper for packaging your binary as Lambda function

- Provides custom hooks between build steps if you have something special (though this might be a smell)