Documentation
¶
Index ¶
- Constants
- Variables
- func DisableColor(noColor bool)
- func EnvOrDefault(key string, defaultVal string) string
- func Exit(err error)
- func ExitWithVersion()
- func VerifyBuildpackAPI(kind, name, requestedVersion string, logger log.Logger) error
- func VerifyPlatformAPI(requestedVersion string, logger log.Logger) error
- type BuildpackAPIVerifier
- type ErrorFail
Constants ¶
const ( // EnvPlatformAPI configures the Platform API version. EnvPlatformAPI = "CNB_PLATFORM_API" EnvDeprecationMode = "CNB_DEPRECATION_MODE" DefaultDeprecationMode = ModeWarn ModeQuiet = "quiet" ModeWarn = "warn" ModeError = "error" )
const ( CodeForFailed = 1 // 2: reserved CodeForInvalidArgs = 3 CodeForIncompatiblePlatformAPI = 11 CodeForIncompatibleBuildpackAPI = 12 )
Variables ¶
var ( DefaultLogger = log.NewDefaultLogger(Stdout) Stdout = color.NewConsole(os.Stdout) Stderr = color.NewConsole(os.Stderr) )
var ( // Version is the version of the lifecycle and all produced binaries. Version = "0.0.0" // SCMCommit is the commit information provided by SCM. SCMCommit = "" // SCMRepository is the source repository. SCMRepository = "" )
The following variables are injected at compile time.
var DeprecationMode = EnvOrDefault(EnvDeprecationMode, DefaultDeprecationMode)
Functions ¶
func DisableColor ¶ added in v0.9.2
func DisableColor(noColor bool)
func EnvOrDefault ¶ added in v0.9.0
func ExitWithVersion ¶
func ExitWithVersion()
func VerifyBuildpackAPI ¶ added in v0.9.0
VerifyBuildpackAPI given a Buildpack API version and relevant information for logging will error if the requested version is unsupported, and will log a warning, error, or do nothing if the requested version is deprecated, depending on if the configured deprecation mode is "warn", "error", or "silent", respectively.
func VerifyPlatformAPI ¶ added in v0.9.0
VerifyPlatformAPI given a Platform API version and relevant information for logging will error if the requested version is unsupported, and will log a warning, error, or do nothing if the requested version is deprecated, depending on if the configured deprecation mode is "warn", "error", or "silent", respectively.
Types ¶
type BuildpackAPIVerifier ¶ added in v0.15.0
type BuildpackAPIVerifier struct{}
func (*BuildpackAPIVerifier) VerifyBuildpackAPI ¶ added in v0.15.0
func (v *BuildpackAPIVerifier) VerifyBuildpackAPI(kind, name, requestedVersion string, logger log.Logger) error
VerifyBuildpackAPI given a Buildpack API version and relevant information for logging will error if the requested version is unsupported, and will log a warning, error, or do nothing if the requested version is deprecated, depending on if the configured deprecation mode is "warn", "error", or "silent", respectively.
Source Files
Directories