build

Documentation

Index

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

Constants

const SuccessStatusCode = 0

SuccessStatusCode is the status code returned for success.

Types

type Build

type Build struct {
	// Application is the application being processed by the buildpack.
	Application application.Application

	// 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

	// Platform represents components contributed by the platform to the buildpack.
	Platform platform.Platform

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

	// Stack is the stack currently available to the application.
	Stack stack.Stack

	// Writer is the writer used to write the build plan in Success().
	Writer buildpackplan.Writer
}

Build represents all of the components available to a buildpack at build time.

func DefaultBuild

func DefaultBuild() (Build, error)

DefaultBuild creates a new instance of Build using default values.

func (Build) Failure

func (b Build) Failure(code int) int

Failure signals an unsuccessful build by exiting with a specified positive status code.

func (Build) Success

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

Success signals a successful build by exiting with a zero status code.