buildpack

package
v1.5.0 Latest Latest
Warning

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

Go to latest
Published: Dec 5, 2018 License: Apache-2.0 Imports: 7 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BuildImages

type BuildImages string

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

type Buildpack

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

	// Stacks is the collection of stacks that the buildpack supports.
	Stacks []Stack `toml:"stacks"`

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

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

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

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

func (b Buildpack) String() string

String makes Buildpack satisfy the Stringer interface.

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.

func (Info) String

func (i Info) String() string

String makes Info satisfy the Stringer interface.

type Metadata

type Metadata map[string]interface{}

Metadata is additional metadata included in the buildpack

type RunImages

type RunImages string

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

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.

func (Stack) String

func (s Stack) String() string

String makes Stack satisfy the Stringer interface.

Jump to

Keyboard shortcuts

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