build

package
v1.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2019 License: Apache-2.0 Imports: 10 Imported by: 4

Documentation

Index

Constants

View Source
const SuccessStatusCode = 0

SuccessStatusCode is the status code returned for success.

Variables

This section is empty.

Functions

This section is empty.

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

	// BuildPlan represents dependencies contributed by previous builds.
	BuildPlan buildplan.BuildPlan

	// BuildPlanWriter is the writer used to write the BuildPlan in Pass().
	BuildPlanWriter buildplan.Writer

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

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

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) String

func (b Build) String() string

String makes Build satisfy the Stringer interface.

func (Build) Success

func (b Build) Success(buildPlan buildplan.BuildPlan) (int, error)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL