buildplan

README

Build Plan Cloud Native Buildpack

This buildpack is meant to be used to write a Build Plan generated from the contents of an plan.toml in the base of the application directory. The plan.toml is meant to reflect the contents of Build Plan (TOML) that is currently supported by packit.

Usage

To package this buildpack for consumption:

$ ./scripts/package.sh

This builds the buildpack's Go source using GOOS=linux by default. You can supply another value as the first argument to package.sh.

plan.toml

[[requires]]
name = "<dependency name>"

[requires.metadata]
# buildpack-specific data

[[or]]

[[or.requires]]
name = "<dependency name>"

[or.requires.metadata]
# buildpack-specific data

If you are looking for concrete definitions on what these fields do inside of packit you can check the documentation here. For the definition from the Cloud Native Buildpack specification itself you can check out the documentation here.

Documentation

Index

• func Build() packit.BuildFunc
• func Detect(planParser PlanParser) packit.DetectFunc
• type BuildPlanParser
  • func NewBuildPlanParser() BuildPlanParser
  • func (p BuildPlanParser) Parse(path string) ([]packit.BuildPlanRequirement, []packit.BuildPlanRequirement, error)
• type PlanParser

Functions

func Build

func Build() packit.BuildFunc

func Detect

func Detect(planParser PlanParser) packit.DetectFunc

Types

type BuildPlanParser

type BuildPlanParser struct{}

func NewBuildPlanParser

func NewBuildPlanParser() BuildPlanParser

func (BuildPlanParser) Parse

func (p BuildPlanParser) Parse(path string) ([]packit.BuildPlanRequirement, []packit.BuildPlanRequirement, error)

type PlanParser

type PlanParser interface {
	Parse(path string) (requirements []packit.BuildPlanRequirement, orRequirements []packit.BuildPlanRequirement, err error)
}