go-mod-cnb

README

Go Mod Cloud Native Buildpack

The Go Mod CNB builds a Go application binary, using the go mod functionality provided by the Go Compiler CNB to package dependencies.

Integration

The Go Mod CNB provides go-mod as a dependency. Downstream buildpacks can require the node dependency by generating a Build Plan TOML file that looks like the following:

[[requires]]

  # The name of the Go Mod dependency is "go-mod". This value is
  # considered part of the public API for the buildpack and will not change
  # without a plan for deprecation.
  name = "go-mod"

  # Note: The version field is unsupported as there is no version for a set of
  # go-mod.

  # The Go Mod buildpack supports some non-required metadata options.
  [requires.metadata]

    # Setting the build flag to true will ensure that the Go Mod
    # depdendency is available on the $PATH for subsequent buildpacks during
    # their build phase. If you are writing a buildpack that needs to run Go Mod
    # during its build process, this flag should be set to true.
    build = true

Usage

To package this buildpack for consumption:

$ ./scripts/package.sh

This builds the buildpack's Go source using GOOS=linux by default. You can supply another value as the first argument to package.sh.

Applications outside the root directory

If your application's main package is not in the root of the directory, then you'll need to specify this in the buildpack.yml file. Here's an example of how to do that:

go:
  targets: ["./cmd/web"]