buildpackplan

Documentation

Index

• type Metadata
• type Plan
• type Plans
  • func DefaultPlans(path string, logger logger.Logger) (Plans, error)
• type Writer
  • func DefaultWriter(index int) Writer

Types

type Metadata

type Metadata map[string]interface{}

Metadata is the metadata of the plan.

type Plan

type Plan struct {
	// Name represents the name of the plan.
	Name string `toml:"name"`

	// Version represents the version of the plan.  Optional.
	Version string `toml:"version,omitempty"`

	// Metadata represents the metadata of the plan.  Optional.
	Metadata Metadata `toml:"metadata,omitempty"`
}

Plan represents a contractual buildpack plan.

type Plans

type Plans struct {
	// Entries represents all of the buildpack plans.
	Entries []Plan `toml:"entries,omitempty"`
}

Plans is a collection of Plan's in marshalable form.

func DefaultPlans

func DefaultPlans(path string, logger logger.Logger) (Plans, error)

DefaultPlans creates a new instance of Plans, unmarshalling it from a TOML file.

type Writer

type Writer func(plans Plans) error

Writer is a function write writes the contents of a Plans

func DefaultWriter

func DefaultWriter(index int) Writer

DefaultWriter writes the Plans to a file at os.Args[<INDEX>].