Documentation
¶
Index ¶
- Constants
- Variables
- func Build(entries EntryResolver, dependencies DependencyManager, ...) packit.BuildFunc
- func Detect(nvmrcParser, buildpackYMLParser VersionParser) packit.DetectFunc
- type BuildPlanMetadata
- type Buildpack
- type BuildpackInfo
- type BuildpackMetadata
- type BuildpackMetadataDefaultVersions
- type BuildpackMetadataDependency
- type BuildpackMetadataDependencyStacks
- type BuildpackYMLParser
- type CacheHandler
- type CacheManager
- type Clock
- type Config
- type DependencyManager
- type EngineDependencyManager
- type EntryResolver
- type Environment
- type EnvironmentConfiguration
- type EnvironmentVariables
- type NvmrcParser
- type PlanEntryResolver
- type PlanRefiner
- type PlanRefinery
- type Transport
- 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 PlanRefinery, cacheManager CacheManager, logger scribe.Logger, 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 Buildpack ¶ added in v0.0.139
type Buildpack struct {
Info BuildpackInfo `toml:"buildpack"`
Metadata BuildpackMetadata `toml:"metadata"`
}
func ParseBuildpack ¶ added in v0.0.139
type BuildpackInfo ¶ added in v0.0.139
type BuildpackMetadata ¶ added in v0.0.139
type BuildpackMetadata struct {
DefaultVersions BuildpackMetadataDefaultVersions `toml:"default-versions"`
Dependencies []BuildpackMetadataDependency `toml:"dependencies"`
}
type BuildpackMetadataDefaultVersions ¶ added in v0.0.139
type BuildpackMetadataDefaultVersions struct {
Node string `toml:"node"`
}
type BuildpackMetadataDependency ¶ added in v0.0.139
type BuildpackMetadataDependencyStacks ¶ added in v0.0.139
type BuildpackMetadataDependencyStacks []string
func (BuildpackMetadataDependencyStacks) Include ¶ added in v0.0.139
func (stacks BuildpackMetadataDependencyStacks) Include(stack string) bool
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 CacheHandler ¶ added in v0.0.139
type CacheHandler struct{}
func NewCacheHandler ¶ added in v0.0.139
func NewCacheHandler() CacheHandler
func (CacheHandler) Match ¶ added in v0.0.139
func (ch CacheHandler) Match(layer packit.Layer, dependency BuildpackMetadataDependency) (bool, error)
type CacheManager ¶ added in v0.0.139
type CacheManager interface {
Match(layer packit.Layer, dependency BuildpackMetadataDependency) (bool, error)
}
type DependencyManager ¶ added in v0.0.139
type DependencyManager interface {
Resolve(dependencies []BuildpackMetadataDependency, defaultVersion, stack string, entry packit.BuildpackPlanEntry) (BuildpackMetadataDependency, error)
Install(dependency BuildpackMetadataDependency, cnbPath, layerPath string) error
}
type EngineDependencyManager ¶ added in v0.0.139
type EngineDependencyManager struct {
// contains filtered or unexported fields
}
func NewEngineDependencyManager ¶ added in v0.0.139
func NewEngineDependencyManager(transport Transport, logger scribe.Logger) EngineDependencyManager
func (EngineDependencyManager) Install ¶ added in v0.0.139
func (e EngineDependencyManager) Install(dependency BuildpackMetadataDependency, cnbPath, layerPath string) error
func (EngineDependencyManager) Resolve ¶ added in v0.0.139
func (e EngineDependencyManager) Resolve(dependencies []BuildpackMetadataDependency, defaultVersion, stack string, entry packit.BuildpackPlanEntry) (BuildpackMetadataDependency, 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 scribe.Logger) Environment
func (Environment) Configure ¶ added in v0.0.139
func (e Environment) Configure(env EnvironmentVariables, path string, optimizeMemory bool) error
type EnvironmentConfiguration ¶ added in v0.0.139
type EnvironmentConfiguration interface {
Configure(env EnvironmentVariables, path string, optimizeMemory bool) error
}
type EnvironmentVariables ¶ added in v0.0.139
type EnvironmentVariables interface {
Override(key, value string)
}
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 scribe.Logger) PlanEntryResolver
func (PlanEntryResolver) Resolve ¶ added in v0.0.139
func (r PlanEntryResolver) Resolve(entries []packit.BuildpackPlanEntry) packit.BuildpackPlanEntry
type PlanRefiner ¶ added in v0.0.139
type PlanRefiner struct{}
func NewPlanRefiner ¶ added in v0.0.139
func NewPlanRefiner() PlanRefiner
func (PlanRefiner) BillOfMaterial ¶ added in v0.0.139
func (pf PlanRefiner) BillOfMaterial(dependency BuildpackMetadataDependency) packit.BuildpackPlan
type PlanRefinery ¶ added in v0.0.139
type PlanRefinery interface {
BillOfMaterial(dependency BuildpackMetadataDependency) packit.BuildpackPlan
}
type Transport ¶ added in v0.0.139
type Transport interface {
Drop(root, uri string) (io.ReadCloser, error)
}
type VersionParser ¶ added in v0.0.139
Source Files
¶
Click to show internal directories.
Click to hide internal directories.