buildpack

Documentation

Index

• type BuildImage
• type BuildImages
• type Buildpack
  • func DefaultBuildpack(logger logger.Logger) (Buildpack, error)
  • func New(rootDir string, logger logger.Logger) (Buildpack, error)
• type Info
• type Metadata
• type RunImage
• type RunImages
• type Stack

Types

type BuildImage

type BuildImage string

BuildImage is the build image source for a particular stack id.

type BuildImages

type BuildImages []BuildImage

BuildImages is a collection of BuildImages.

type Buildpack

type Buildpack struct {
	// Info is information about the buildpack.
	Info Info `toml:"buildpack"`

	// Metadata is the additional metadata included in the buildpack.
	Metadata Metadata `toml:"metadata"`

	// Root is the path to the root directory for the buildpack.
	Root string

	// Stacks is the collection of stacks that the buildpack supports.
	Stacks []Stack `toml:"stacks"`
	// contains filtered or unexported fields
}

Buildpack represents the metadata associated with a buildpack.

func DefaultBuildpack

func DefaultBuildpack(logger logger.Logger) (Buildpack, error)

DefaultBuildpack creates a new instance of Buildpack extracting the contents of the buildpack.toml file in the root of the buildpack.

func New

func New(rootDir string, logger logger.Logger) (Buildpack, error)

New creates an instance of Buildpack given a root dir and a logger extracting the contents of the buildpack.toml file in the root of the buildpack.

type Info

type Info struct {
	// ID is the globally unique identifier of the buildpack.
	ID string `toml:"id"`

	// Name is the human readable name of the buildpack.
	Name string `toml:"name"`

	// Version is the semver-compliant version of the buildpack.
	Version string `toml:"version"`
}

Info is information about the buildpack.

type Metadata

type Metadata map[string]interface{}

Metadata is additional metadata included in the buildpack

type RunImage

type RunImage string

RunImage is the run image source for a particular stack id.

type RunImages

type RunImages []RunImage

RunImages is a collection of RunImages.

type Stack

type Stack struct {
	// ID is the globally unique identifier of the stack.
	ID string `toml:"id"`

	// BuildImages are the suggested sources for stacks if the platform is unaware of the stack id.
	BuildImages BuildImages `toml:"build-images"`

	// RunImages are the suggested sources for stacks if the platform is unaware of the stack id.
	RunImages RunImages `toml:"run-images"`
}

Stack represents metadata about the stacks associated with the buildpack.