Go app template build environment
This is a skeleton project for a Go application, which captures the best build techniques I have learned to date. It uses a Makefile to drive the build (the universal API to software projects) and a Dockerfile to build a docker image.
This has only been tested on Linux, and depends on Docker to build.
To use this, simply copy these files and make the following changes:
BINSto your binary name(s)
cmd/myapp-*with one directory for each of your
REGISTRYto the Docker registry you want to use
- choose a strategy for
VERSIONvalues - git tags or manual
- maybe change or remove the
USERif you need
This assumes the use of go modules (which is the default for all Go builds as of Go 1.13).
This includes go-licenses and golangci-lint, but they are kept in the
sub-module. If you don't want those (or their dependencies, they can be
make build to compile your app. This will use docker to build
your app, with the current directory volume-mounted into place. This will
store incremental state for the fastest possible build. Run
to build for all architectures.
make container to build the container image. It will calculate the image
tag based on the most recent git tag, and whether the repo is "dirty" since
that tag (see
make version). Run
make all-container to build containers
for all supported architectures.
make push to push the container image to
to push the container images for all architectures.
make clean to clean up.
make help to get a list of available targets.
make test and
make lint to run tests and linters, respectively. Like
building, this will use docker to execute.
The golangci-lint tool looks for configuration in
.golangci.yaml. If that
file is not provided, it will use its own built-in defaults.