libcnb

Jul 7, 2023

Changes in this version

+ const EnvVcapServices

type Bindings

+ func NewBindingsFromVcapServicesEnv(content string) (Bindings, error)

Apr 11, 2022

Changes in this version

+ const MaxSupportedBPVersion

+ const MinSupportedBPVersion

type Process

+ WorkingDirectory string

Feb 2, 2022

Changes in this version

type Option

+ func WithBOMLabel(bomLabel bool) Option

Nov 24, 2021

Changes in this version

+ const BOMFormatCycloneDXExtension

+ const BOMFormatSPDXExtension

+ const BOMFormatSyftExtension

+ const BOMMediaTypeCycloneDX

+ const BOMMediaTypeSPDX

+ const BOMMediaTypeSyft

+ const BOMUnknown

type BuildpackInfo

+ SBOMFormats []string

type SBOMFormat

+ const UnknownFormat

+ func SBOMFormatFromString(from string) (SBOMFormat, error)

+ func (b SBOMFormat) MediaType() string

Nov 18, 2021

Changes in this version

type Layer

+ func (l Layer) SBOMPath(bt SBOMFormat) string

type Layers

+ func (l Layers) BuildSBOMPath(bt SBOMFormat) string

+ func (l Layers) LaunchSBOMPath(bt SBOMFormat) string

+ type SBOMFormat int

+ const CycloneDXJSON

+ const SPDXJSON

+ const SyftJSON

+ func (b SBOMFormat) String() string

Oct 27, 2021

Changes in this version

+ func RunExecD(execDMap map[string]ExecD, options ...Option)

+ type ExecD interface

+ Execute func() (map[string]string, error)

+ type ExecDWriter interface

+ Write func(value map[string]string) error

type Option

+ func WithExecDWriter(execdWriter ExecDWriter) Option

Jul 1, 2021

Changes in this version

+ const EnvCNBBindings

+ const EnvServiceBindings

type Bindings

+ func NewBindingsForBuild(platformDir string) (Bindings, error)

+ func NewBindingsForLaunch() (Bindings, error)

Apr 7, 2021

Changes in this version

type BuildpackInfo

+ Description string

+ Keywords []string

+ Licenses []License

+ type License struct

+ Type string

+ URI string

type Process

+ Default bool

Feb 1, 2021

Changes in this version

+ type BOM struct

+ Entries []BOMEntry

+ type BOMEntry struct

+ Build bool

+ Launch bool

+ Metadata map[string]interface{}

+ Name string

type BuildResult

+ BOM *BOM

+ Unmet []UnmetPlanEntry

+ type BuildTOML struct

+ BOM []BOMEntry

+ Unmet []UnmetPlanEntry

+ type LaunchTOML struct

+ BOM []BOMEntry

+ Labels []Label

+ Processes []Process

+ Slices []Slice

+ type LayerTypes struct

+ Build bool

+ Cache bool

+ Launch bool

+ type UnmetPlanEntry struct

+ Name string

Aug 17, 2020

Changes in this version

+ type Exec struct

+ Path string

+ func (e Exec) FilePath(name string) string

+ func (e Exec) ProcessFilePath(processType string, name string) string

type Layer

+ Exec Exec

Jul 13, 2020

Changes in this version

+ const BindingType

type Binding

+ func (b Binding) Type() string

Jul 2, 2020

Changes in this version

type Environment

+ func (e Environment) ProcessAppend(processType string, name string, a ...interface{})

+ func (e Environment) ProcessAppendf(processType string, name string, format string, a ...interface{})

+ func (e Environment) ProcessDefault(processType string, name string, a ...interface{})

+ func (e Environment) ProcessDefaultf(processType string, name string, format string, a ...interface{})

+ func (e Environment) ProcessDelimiter(processType string, name string, delimiter string)

+ func (e Environment) ProcessOverride(processType string, name string, a ...interface{})

+ func (e Environment) ProcessOverridef(processType string, name string, format string, a ...interface{})

+ func (e Environment) ProcessPrepend(processType string, name string, a ...interface{})

+ func (e Environment) ProcessPrependPath(processType string, name string, a ...interface{})

+ func (e Environment) ProcessPrependPathf(processType string, name string, format string, a ...interface{})

+ func (e Environment) ProcessPrependf(processType string, name string, format string, a ...interface{})

type Profile

+ func (p Profile) ProcessAdd(processType string, name string, a ...interface{})

+ func (p Profile) ProcessAddf(processType string, name string, format string, a ...interface{})

May 8, 2020

Changes in this version

type Binding

+ Path string

+ func (b Binding) MetadataFilePath(name string) (string, bool)

+ func (b Binding) SecretFilePath(name string) (string, bool)

May 5, 2020

Changes in this version

+ func Main(detector Detector, builder Builder, options ...Option)

Apr 22, 2020

Changes in this version

type BuildResult

+ Labels []Label

type BuildpackInfo

+ Homepage string

+ type Label struct

+ Key string

+ Value string

type Launch

+ Labels []Label

Apr 20, 2020

Changes in this version

type BuildResult

+ func NewBuildResult() BuildResult

Mar 27, 2020

Changes in this version

type Environment

+ func (e Environment) Appendf(name string, format string, a ...interface{})

+ func (e Environment) Defaultf(name string, format string, a ...interface{})

+ func (e Environment) Overridef(name string, format string, a ...interface{})

+ func (e Environment) PrependPathf(name string, format string, a ...interface{})

+ func (e Environment) Prependf(name string, format string, a ...interface{})

type Profile

+ func (p Profile) Addf(name string, format string, a ...interface{})

Mar 18, 2020

Changes in this version

type Binding

+ Name string

+ func (b Binding) Kind() string

+ func (b Binding) Provider() string

+ func (b Binding) Tags() []string

Mar 16, 2020

Changes in this version

type BuildResult

+ func (b BuildResult) String() string

Mar 13, 2020

Changes in this version

+ type Builder interface

+ Build func(context BuildContext) (BuildResult, error)

+ type Detector interface

+ Detect func(context DetectContext) (DetectResult, error)

Mar 4, 2020

Changes in this version

+ type Application struct

+ Path string

type BuildContext

+ Application Application

type Buildpack

+ Path string

type DetectContext

+ Application Application

Mar 3, 2020

Changes in this version

+ const BindingKind

+ const BindingProvider

+ const BindingTags

+ func Build(f BuildFunc, options ...Option)

+ func Detect(f DetectFunc, options ...Option)

+ type ApplicationPathFormatter string

+ func (a ApplicationPathFormatter) String() string

+ type Binding struct

+ Metadata map[string]string

+ Secret map[string]string

+ func NewBinding() Binding

+ func NewBindingFromPath(path string) (Binding, error)

+ func (b Binding) String() string

+ type Bindings map[string]Binding

+ func NewBindingsFromEnvironment(name string) (Bindings, error)

+ func NewBindingsFromPath(path string) (Bindings, error)

+ type BuildContext struct

+ ApplicationPath string

+ Buildpack Buildpack

+ BuildpackPath string

+ Layers Layers

+ PersistentMetadata map[string]interface{}

+ Plan BuildpackPlan

+ Platform Platform

+ StackID string

+ type BuildFunc func(BuildContext) (BuildResult, error)

+ type BuildPlan struct

+ Provides []BuildPlanProvide

+ Requires []BuildPlanRequire

+ type BuildPlanProvide struct

+ Name string

+ type BuildPlanRequire struct

+ Metadata map[string]interface{}

+ Name string

+ Version string

+ type BuildPlans struct

+ Or []BuildPlan

+ type BuildResult struct

+ Layers []LayerContributor

+ PersistentMetadata map[string]interface{}

+ Plan BuildpackPlan

+ Processes []Process

+ Slices []Slice

+ type Buildpack struct

+ API string

+ Info BuildpackInfo

+ Metadata map[string]interface{}

+ Orders []BuildpackOrder

+ Stacks []BuildpackStack

+ type BuildpackInfo struct

+ ClearEnvironment bool

+ ID string

+ Name string

+ Version string

+ type BuildpackOrder struct

+ Groups []BuildpackOrderBuildpack

+ type BuildpackOrderBuildpack struct

+ ID string

+ Optional bool

+ Version string

+ type BuildpackPathFormatter string

+ func (b BuildpackPathFormatter) String() string

+ type BuildpackPlan struct

+ Entries []BuildpackPlanEntry

+ type BuildpackPlanEntry struct

+ Metadata map[string]interface{}

+ Name string

+ Version string

+ type BuildpackStack struct

+ ID string

+ Mixins []string

+ type Config struct

+ type DetectContext struct

+ ApplicationPath string

+ Buildpack Buildpack

+ BuildpackPath string

+ Platform Platform

+ StackID string

+ type DetectFunc func(DetectContext) (DetectResult, error)

+ type DetectResult struct

+ Pass bool

+ Plans []BuildPlan

+ type Environment map[string]string

+ func (e Environment) Append(name string, format string, a ...interface{})

+ func (e Environment) Default(name string, format string, a ...interface{})

+ func (e Environment) Delimiter(name string, delimiter string)

+ func (e Environment) Override(name string, format string, a ...interface{})

+ func (e Environment) Prepend(name string, format string, a ...interface{})

+ func (e Environment) PrependPath(name string, format string, a ...interface{})

+ type EnvironmentWriter interface

+ Write func(dir string, environment map[string]string) error

+ type ExitHandler interface

+ Error func(error)

+ Fail func()

+ Pass func()

+ type Launch struct

+ Processes []Process

+ Slices []Slice

+ type Layer struct

+ Build bool

+ BuildEnvironment Environment

+ Cache bool

+ Launch bool

+ LaunchEnvironment Environment

+ Metadata map[string]interface{}

+ Name string

+ Path string

+ Profile Profile

+ SharedEnvironment Environment

+ type LayerContributor interface

+ Contribute func(Layer) (Layer, error)

+ Name func() string

+ type Layers struct

+ Path string

+ func (l *Layers) Layer(name string) (Layer, error)

+ type Option func(config Config) Config

+ func WithArguments(arguments []string) Option

+ func WithEnvironmentWriter(environmentWriter EnvironmentWriter) Option

+ func WithExitHandler(exitHandler ExitHandler) Option

+ func WithTOMLWriter(tomlWriter TOMLWriter) Option

+ type Platform struct

+ Bindings Bindings

+ Environment map[string]string

+ Path string

+ type PlatformFormatter Platform

+ func (p PlatformFormatter) String() string

+ type Process struct

+ Arguments []string

+ Command string

+ Direct bool

+ Type string

+ type Profile map[string]string

+ func (p Profile) Add(name string, format string, a ...interface{})

+ type Slice struct

+ Paths []string

+ type Store struct

+ Metadata map[string]interface{}

+ type TOMLWriter interface

+ Write func(path string, value interface{}) error