Documentation
¶
Index ¶
- Constants
- Variables
- func Build(entries EntryResolver, dependencies DependencyManager, ...) packit.BuildFunc
- func Detect(nvmrcParser, buildpackYMLParser VersionParser) packit.DetectFunc
- type BuildPlanMetadata
- type BuildPlanRefinery
- type BuildpackYMLParser
- type Clock
- type Config
- type DependencyManager
- type EntryResolver
- type Environment
- type EnvironmentConfiguration
- type LogEmitter
- type NvmrcParser
- type PlanEntryResolver
- type PlanRefinery
- type VersionParser
Constants ¶
View Source
const ( Node = "node" Dependency = Node // NOTE: alias for old constant name DepKey = "dependency-sha" NvmrcSource = ".nvmrc" BuildpackYMLSource = "buildpack.yml" )
Variables ¶
View Source
var ( MemoryAvailableScript = strings.TrimSpace(` if [[ -z "$MEMORY_AVAILABLE" ]]; then memory_in_bytes="$(cat /sys/fs/cgroup/memory/memory.limit_in_bytes)" MEMORY_AVAILABLE="$(( $memory_in_bytes / ( 1024 * 1024 ) ))" fi export MEMORY_AVAILABLE `) OptimizeMemoryScript = `export NODE_OPTIONS="--max_old_space_size=$(( $MEMORY_AVAILABLE * 75 / 100 ))"` )
Functions ¶
func Build ¶ added in v0.0.139
func Build(entries EntryResolver, dependencies DependencyManager, environment EnvironmentConfiguration, planRefinery BuildPlanRefinery, logger LogEmitter, clock Clock) packit.BuildFunc
func Detect ¶ added in v0.0.139
func Detect(nvmrcParser, buildpackYMLParser VersionParser) packit.DetectFunc
Types ¶
type BuildPlanMetadata ¶ added in v0.0.139
type BuildPlanMetadata struct {
VersionSource string `toml:"version-source"`
}
type BuildPlanRefinery ¶ added in v0.0.166
type BuildPlanRefinery interface {
BillOfMaterial(dependency postal.Dependency) packit.BuildpackPlan
}
type BuildpackYMLParser ¶ added in v0.0.139
type BuildpackYMLParser struct{}
func NewBuildpackYMLParser ¶ added in v0.0.139
func NewBuildpackYMLParser() BuildpackYMLParser
func (BuildpackYMLParser) Parse ¶ added in v0.0.139
func (p BuildpackYMLParser) Parse(path string) (Config, error)
func (BuildpackYMLParser) ParseVersion ¶ added in v0.0.139
func (p BuildpackYMLParser) ParseVersion(path string) (string, error)
type DependencyManager ¶ added in v0.0.139
type DependencyManager interface {
Resolve(path, id, version, stack string) (postal.Dependency, error)
Install(dependency postal.Dependency, cnbPath, layerPath string) error
}
type EntryResolver ¶ added in v0.0.139
type EntryResolver interface {
Resolve([]packit.BuildpackPlanEntry) packit.BuildpackPlanEntry
}
type Environment ¶ added in v0.0.139
type Environment struct {
// contains filtered or unexported fields
}
func NewEnvironment ¶ added in v0.0.139
func NewEnvironment(logger LogEmitter) Environment
func (Environment) Configure ¶ added in v0.0.139
func (e Environment) Configure(env packit.Environment, path string, optimizeMemory bool) error
type EnvironmentConfiguration ¶ added in v0.0.139
type EnvironmentConfiguration interface {
Configure(env packit.Environment, path string, optimizeMemory bool) error
}
type LogEmitter ¶ added in v0.0.168
type LogEmitter struct {
// Logger is embedded and therefore delegates all of its functions to the
// LogEmitter.
scribe.Logger
}
func NewLogEmitter ¶ added in v0.0.168
func NewLogEmitter(output io.Writer) LogEmitter
func (LogEmitter) Candidates ¶ added in v0.0.168
func (e LogEmitter) Candidates(entries []packit.BuildpackPlanEntry)
func (LogEmitter) Environment ¶ added in v0.0.168
func (e LogEmitter) Environment(env packit.Environment, optimizeMemory bool)
func (LogEmitter) SelectedDependency ¶ added in v0.0.168
func (e LogEmitter) SelectedDependency(entry packit.BuildpackPlanEntry, dependency postal.Dependency, now time.Time)
type NvmrcParser ¶ added in v0.0.139
type NvmrcParser struct{}
func NewNvmrcParser ¶ added in v0.0.139
func NewNvmrcParser() NvmrcParser
func (NvmrcParser) ParseVersion ¶ added in v0.0.139
func (p NvmrcParser) ParseVersion(path string) (string, error)
type PlanEntryResolver ¶ added in v0.0.139
type PlanEntryResolver struct {
// contains filtered or unexported fields
}
func NewPlanEntryResolver ¶ added in v0.0.139
func NewPlanEntryResolver(logger LogEmitter) PlanEntryResolver
func (PlanEntryResolver) Resolve ¶ added in v0.0.139
func (r PlanEntryResolver) Resolve(entries []packit.BuildpackPlanEntry) packit.BuildpackPlanEntry
type PlanRefinery ¶ added in v0.0.139
type PlanRefinery struct{}
func NewPlanRefinery ¶ added in v0.0.166
func NewPlanRefinery() PlanRefinery
func (PlanRefinery) BillOfMaterial ¶ added in v0.0.139
func (pf PlanRefinery) BillOfMaterial(dependency postal.Dependency) packit.BuildpackPlan
type VersionParser ¶ added in v0.0.139
Source Files
¶
Click to show internal directories.
Click to hide internal directories.