buildpackage

Documentation

Index

• type Config
  • func DefaultConfig() Config
  • func DefaultExtensionConfig() Config
• type ConfigReader
  • func NewConfigReader() *ConfigReader
  • func (r *ConfigReader) Read(path string) (Config, error)
  • func (r *ConfigReader) ReadBuildpackDescriptor(path string) (dist.BuildpackDescriptor, error)

Types

type Config

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

	// Define targets for composite buildpacks
	Targets []dist.Target `toml:"targets"`
}

Config encapsulates the possible configuration options for buildpackage creation.

func DefaultConfig

func DefaultConfig() Config

func DefaultExtensionConfig

func DefaultExtensionConfig() 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.

func (*ConfigReader) ReadBuildpackDescriptor

func (r *ConfigReader) ReadBuildpackDescriptor(path string) (dist.BuildpackDescriptor, error)