build

package
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Nov 29, 2018 License: Apache-2.0 Imports: 8 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 applicationPkg.Application

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

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

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

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

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

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

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

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 buildplanPkg.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