github.com/paketo-buildpacks/packit@v1.3.2-0.20211206231111-86b75c657449/buildpack_plan.go (about)

     1  package packit
     2  
     3  // BuildpackPlan is a representation of the buildpack plan provided by the
     4  // lifecycle and defined in the specification:
     5  // https://github.com/buildpacks/spec/blob/main/buildpack.md#buildpack-plan-toml.
     6  // It is also used to return a set of refinements to the plan at the end of the
     7  // build phase.
     8  type BuildpackPlan struct {
     9  	// Entries is a list of BuildpackPlanEntry fields that are declared in the
    10  	// buildpack plan TOML file.
    11  	Entries []BuildpackPlanEntry `toml:"entries"`
    12  }
    13  
    14  // BuildpackPlanEntry is a representation of a single buildpack plan entry
    15  // specified by the lifecycle.
    16  type BuildpackPlanEntry struct {
    17  	// Name is the name of the dependency the the buildpack should provide.
    18  	Name string `toml:"name"`
    19  
    20  	// Metadata is an unspecified field allowing buildpacks to communicate extra
    21  	// details about their requirement. Examples of this type of metadata might
    22  	// include details about what source was used to decide the version
    23  	// constraint for a requirement.
    24  	Metadata map[string]interface{} `toml:"metadata"`
    25  }