buildpackage

Documentation

Index

• Constants
• func ExtractBuildpacks(pkg Package) (mainBP dist.Buildpack, depBPs []dist.Buildpack, err error)
• type Config
  • func DefaultConfig() Config
• type ConfigReader
  • func NewConfigReader() *ConfigReader
  • func (r *ConfigReader) Read(path string) (Config, error)
• type Metadata
• type Package

Constants

const MetadataLabel = "io.buildpacks.buildpackage.metadata"

Functions

func ExtractBuildpacks

func ExtractBuildpacks(pkg Package) (mainBP dist.Buildpack, depBPs []dist.Buildpack, err error)

Types

type Config

type Config struct {
	Buildpack    dist.BuildpackURI `toml:"buildpack"`
	Dependencies []dist.ImageOrURI `toml:"dependencies"`
	Platform     dist.Platform     `toml:"platform"`
}

Config encapsulates the possible configuration options for buildpackage creation.

func DefaultConfig

func DefaultConfig() Config

type ConfigReader

type ConfigReader struct{}

ConfigReader implements a Read method for buildpackage configuration which parses and validates buildpackage configuration from a toml file.

func NewConfigReader

func NewConfigReader() *ConfigReader

NewConfigReader returns an instance of ConfigReader. It does not take any parameters.

func (*ConfigReader) Read

func (r *ConfigReader) Read(path string) (Config, error)

Read reads and validates a buildpackage configuration from the file path provided and returns the configuration and any error that occurred during reading or validation.

type Metadata

type Metadata struct {
	dist.BuildpackInfo
	Stacks []dist.Stack `toml:"stacks" json:"stacks"`
}

type Package

type Package interface {
	Label(name string) (value string, err error)
	GetLayer(diffID string) (io.ReadCloser, error)
}