build

Documentation

Index

• Constants
• type Build
  • func DefaultBuild() (Build, error)
  • func (b Build) Success(plans ...buildpackplan.Plan) (int, error)

Constants

const SuccessStatusCode = build.SuccessStatusCode

SuccessStatusCode is the status code returned for success.

Types

type Build

type Build struct {
	build.Build

	// Buildpack represents the metadata associated with a buildpack.
	Buildpack buildpack.Buildpack

	// Layers represents the launch layers contributed by a buildpack.
	Layers layers.Layers

	// Logger is used to write debug and info to the console.
	Logger logger.Logger

	// Plans represents required contributions.
	Plans buildpackplan.Plans

	// Runner is used to run commands outside of the process.
	Runner runner.Runner

	// Services represents the services bound to the application.
	Services services.Services
}

Build is an extension to libbuildpack.Build that allows additional functionality to be added.

func DefaultBuild

func DefaultBuild() (Build, error)

DefaultBuild creates a new instance of Build using default values. During initialization, all platform environment // variables are set in the current process environment.

func (Build) Success

func (b Build) Success(plans ...buildpackplan.Plan) (int, error)

Success signals a successful build by exiting with a zero status code. Combines specied build plan with build plan entries for all contributed dependencies.