Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

libcnb

package module

Go to main page

Versions in this module

v2

v2.0.0

Oct 25, 2024

Changes in this version

+ const BOMFormatCycloneDXExtension

+ const BOMFormatSPDXExtension

+ const BOMFormatSyftExtension

+ const BOMMediaTypeCycloneDX

+ const BOMMediaTypeSPDX

+ const BOMMediaTypeSyft

+ const BOMUnknown

+ const BindingProvider

+ const BindingType

+ const DefaultPlatformBindingsLocation

+ const EnvBuildPlanPath

+ const EnvBuildpackDirectory

+ const EnvDetectPlanPath

+ const EnvExtensionDirectory

+ const EnvLayersDirectory

+ const EnvOutputDirectory

+ const EnvPlatformDirectory

+ const EnvServiceBindings

+ const EnvStackID

+ const EnvTargetArch

+ const EnvTargetArchVariant

+ const EnvTargetDistroName

+ const EnvTargetDistroVersion

+ const EnvTargetOS

+ const EnvVcapServices

+ const MaxSupportedBPVersion

+ const MinSupportedBPVersion

+ func Build(build BuildFunc, config Config)

+ func BuildpackMain(detect DetectFunc, build BuildFunc, options ...Option)

+ func Detect(detect DetectFunc, config Config)

+ func ExtensionMain(detect DetectFunc, generate GenerateFunc, options ...Option)

+ func Generate(generate GenerateFunc, config Config)

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

+ type Binding struct

+ Name string

+ Path string

+ Provider string

+ Secret map[string]string

+ Type string

+ func NewBinding(name string, path string, secret map[string]string) Binding

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

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

+ func (b Binding) String() string

+ type Bindings []Binding

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

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

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

+ type BuildConfig struct

+ Args []DockerfileArg

+ type BuildContext struct

+ ApplicationPath string

+ Buildpack Buildpack

+ Layers Layers

+ Logger log.Logger

+ PersistentMetadata map[string]interface{}

+ Plan BuildpackPlan

+ Platform Platform

+ StackID string

+ TargetDistro TargetDistro

+ TargetInfo TargetInfo

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

+ type BuildPlan struct

+ Provides []BuildPlanProvide

+ Requires []BuildPlanRequire

+ type BuildPlanProvide struct

+ Name string

+ type BuildPlanRequire struct

+ Metadata map[string]interface{}

+ Name string

+ type BuildPlans struct

+ Or []BuildPlan

+ type BuildResult struct

+ Labels []Label

+ Layers []Layer

+ PersistentMetadata map[string]interface{}

+ Processes []Process

+ Slices []Slice

+ Unmet []UnmetPlanEntry

+ func NewBuildResult() BuildResult

+ func (b BuildResult) String() string

+ type BuildTOML struct

+ Unmet []UnmetPlanEntry

+ type Buildpack struct

+ API string

+ Info BuildpackInfo

+ Metadata map[string]interface{}

+ Path string

+ Stacks []BuildpackStack

+ Targets []Target

+ type BuildpackInfo struct

+ ClearEnvironment bool

+ Description string

+ Homepage string

+ ID string

+ Keywords []string

+ Licenses []License

+ Name string

+ SBOMFormats []string

+ Version string

+ type BuildpackOrder struct

+ Groups []BuildpackOrderBuildpack

+ type BuildpackOrderBuildpack struct

+ ID string

+ Optional bool

+ Version string

+ type BuildpackPlan struct

+ Entries []BuildpackPlanEntry

+ type BuildpackPlanEntry struct

+ Metadata map[string]interface{}

+ Name string

+ type BuildpackStack struct

+ ID string

+ type Config struct

+ func NewConfig(options ...Option) Config

+ type DetectContext struct

+ ApplicationPath string

+ Buildpack Buildpack

+ Extension Extension

+ Logger log.Logger

+ Platform Platform

+ StackID string

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

+ type DetectResult struct

+ Pass bool

+ Plans []BuildPlan

+ type DockerfileArg struct

+ Name string

+ Value string

+ type Environment map[string]string

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

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

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

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

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

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

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

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

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

+ func (e Environment) ProcessAppendf(processType string, name string, delimiter string, format string, ...)

+ 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) 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, delimiter string, a ...interface{})

+ func (e Environment) ProcessPrependf(processType string, name string, delimiter string, format string, ...)

+ type EnvironmentWriter interface

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

+ type Exec struct

+ Path string

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

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

+ type ExecD interface

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

+ type ExecDWriter interface

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

+ type ExitHandler interface

+ Error func(error)

+ Fail func()

+ Pass func()

+ type ExtendConfig struct

+ Build BuildConfig

+ Run BuildConfig

+ type Extension struct

+ API string

+ Info ExtensionInfo

+ Metadata map[string]interface{}

+ Path string

+ Targets []Target

+ type ExtensionInfo struct

+ Description string

+ Homepage string

+ ID string

+ Keywords []string

+ Licenses []License

+ Name string

+ Version string

+ type GenerateContext struct

+ ApplicationPath string

+ Extension Extension

+ Logger log.Logger

+ OutputDirectory string

+ Plan BuildpackPlan

+ Platform Platform

+ StackID string

+ TargetDistro TargetDistro

+ TargetInfo TargetInfo

+ type GenerateFunc func(context GenerateContext) (GenerateResult, error)

+ type GenerateResult struct

+ BuildDockerfile []byte

+ Config *ExtendConfig

+ RunDockerfile []byte

+ Unmet []UnmetPlanEntry

+ func NewGenerateResult() GenerateResult

+ func (b GenerateResult) String() string

+ type Label struct

+ Key string

+ Value string

+ type LaunchTOML struct

+ Labels []Label

+ Processes []Process

+ Slices []Slice

+ type Layer struct

+ BuildEnvironment Environment

+ Exec Exec

+ LaunchEnvironment Environment

+ Metadata map[string]interface{}

+ Name string

+ Path string

+ SharedEnvironment Environment

+ func (l Layer) Reset() (Layer, error)

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

+ type LayerTypes struct

+ Build bool

+ Cache bool

+ Launch bool

+ type Layers struct

+ Path string

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

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

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

+ type License struct

+ Type string

+ URI string

+ type Option func(config Config) Config

+ func WithArguments(arguments []string) Option

+ func WithDirectoryContentFormatter(formatter log.DirectoryContentFormatter) Option

+ func WithEnvironmentWriter(environmentWriter EnvironmentWriter) Option

+ func WithExecDWriter(execdWriter ExecDWriter) Option

+ func WithExitHandler(exitHandler ExitHandler) Option

+ func WithLogger(logger log.Logger) Option

+ func WithTOMLWriter(tomlWriter TOMLWriter) Option

+ type Platform struct

+ Bindings Bindings

+ Environment map[string]string

+ Path string

+ type Process struct

+ Arguments []string

+ Command []string

+ Default bool

+ Type string

+ WorkingDirectory string

+ type SBOMFormat int

+ const CycloneDXJSON

+ const SPDXJSON

+ const SyftJSON

+ const UnknownFormat

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

+ func (b SBOMFormat) MediaType() string

+ func (b SBOMFormat) String() string

+ type Slice struct

+ Paths []string

+ type Store struct

+ Metadata map[string]interface{}

+ type TOMLWriter interface

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

+ type Target struct

+ Distros []TargetDistro

+ type TargetDistro struct

+ Name string

+ Version string

+ type TargetInfo struct

+ Arch string

+ OS string

+ Variant string

+ type UnmetPlanEntry struct

+ Name string

v2.0.0-rc.1

Oct 7, 2024

v2.0.0-alpha.3

Jun 18, 2024

v2.0.0-alpha.2

Oct 23, 2023

v2.0.0-alpha.1

Aug 7, 2023

Other modules containing this package

github.com/buildpacks/libcnb