procfile

Documentation

Index

• Constants
• type Build
  • func (b Build) Build(context libcnb.BuildContext) (libcnb.BuildResult, error)
• type Detect
  • func (d Detect) Detect(context libcnb.DetectContext) (libcnb.DetectResult, error)
• type Procfile
  • func NewProcfileFromBinding(binds libcnb.Bindings) (Procfile, error)
  • func NewProcfileFromEnvironment() (Procfile, error)
  • func NewProcfileFromEnvironmentOrPathOrBinding(path string, binds libcnb.Bindings) (Procfile, error)
  • func NewProcfileFromPath(path string) (Procfile, error)

Constants

const (
	BindingType = "Procfile" // BindingType is used to resolve a binding containing a Procfile
)

Types

type Build

type Build struct {
	Logger bard.Logger
}

func (Build) Build

func (b Build) Build(context libcnb.BuildContext) (libcnb.BuildResult, error)

type Detect

type Detect struct{}

func (Detect) Detect

func (d Detect) Detect(context libcnb.DetectContext) (libcnb.DetectResult, error)

type Procfile

type Procfile map[string]interface{}

Procfile is a map between a logical name and a command.

func NewProcfileFromBinding

func NewProcfileFromBinding(binds libcnb.Bindings) (Procfile, error)

NewProcfileFromBinding creates a Procfile by reading Procfile from bindings if it exists. If it does not exist, returns an empty Procfile.

func NewProcfileFromEnvironment

func NewProcfileFromEnvironment() (Procfile, error)

NewProcfileFromEnvironment creates a Procfile by reading environment variable BP_PROCFILE_DEFAULT_PROCESS if it exists. If it does not exist, returns an empty Procfile.

func NewProcfileFromEnvironmentOrPathOrBinding

func NewProcfileFromEnvironmentOrPathOrBinding(path string, binds libcnb.Bindings) (Procfile, error)

NewProcfileFromEnvironmentOrPathOrBinding attempts to create a merged Procfile from environment and/or given path and bindings. If none can be created, returns an empty Procfile.

func NewProcfileFromPath

func NewProcfileFromPath(path string) (Procfile, error)

NewProcfileFromPath creates a Procfile by reading Procfile from path if it exists. If it does not exist, returns an empty Procfile.