Documentation
¶
Index ¶
- Variables
- func IsRuntimeDir(dir string) bool
- type Configurable
- type Runtime
- func (r *Runtime) BuildPlan() (*bpModel.Build, error)
- func (r *Runtime) Disabled() bool
- func (r *Runtime) Env(inherit bool, useExecutors bool) (map[string]string, error)
- func (r *Runtime) ExecutableDirs() (envdef.ExecutablePaths, error)
- func (r *Runtime) ExecutablePaths() (envdef.ExecutablePaths, error)
- func (r *Runtime) HasCache() bool
- func (r *Runtime) NeedsUpdate() bool
- func (r *Runtime) ResolvedArtifacts() ([]*artifact.Artifact, error)
- func (r *Runtime) Setup(eventHandler events.Handler) *setup.Setup
- func (r *Runtime) SolveAndUpdate(eventHandler events.Handler) error
- func (r *Runtime) Target() setup.Targeter
- func (r *Runtime) Update(setup *setup.Setup, buildResult *model.BuildResult, commit *bpModel.Commit) (rerr error)
Constants ¶
This section is empty.
Variables ¶
var NeedsBuildscriptResetError = errors.New("needs runtime reset")
NeedsBuildscriptResetError is an error returned when the runtime is improperly referenced in the project (eg. missing buildscript)
var NeedsCommitError = errors.New("runtime needs commit")
NeedsCommitError is an error returned when the local runtime's build script has changes that need staging. This is not a fatal error. A runtime can still be used, but a warning should be emitted.
Functions ¶
func IsRuntimeDir ¶
Types ¶
type Configurable ¶
type Runtime ¶
type Runtime struct {
// contains filtered or unexported fields
}
func New ¶
func New(target setup.Targeter, an analytics.Dispatcher, svcm *model.SvcModel, auth *authentication.Auth, cfg Configurable, out output.Outputer) (*Runtime, error)
New attempts to create a new runtime from local storage.
func (*Runtime) Env ¶
Env returns a key-value map of the environment variables that need to be set for this runtime It's different from envDef in that it merges in the current active environment and points the PATH variable to the Executors directory if requested
func (*Runtime) ExecutableDirs ¶
func (r *Runtime) ExecutableDirs() (envdef.ExecutablePaths, error)
func (*Runtime) ExecutablePaths ¶
func (r *Runtime) ExecutablePaths() (envdef.ExecutablePaths, error)
func (*Runtime) HasCache ¶
HasCache tells us whether this runtime has any cached files. Note this does NOT tell you whether the cache is valid.
func (*Runtime) NeedsUpdate ¶
func (*Runtime) ResolvedArtifacts ¶
func (*Runtime) SolveAndUpdate ¶
SolveAndUpdate updates the runtime by downloading all necessary artifacts from the Platform and installing them locally.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package envdef implements a parser for the runtime environment for alternative builds
|
Package envdef implements a parser for the runtime environment for alternative builds |
|
execmeta
Package execmeta models the executor meta data that is communicated from the state tool to executors via file.
|
Package execmeta models the executor meta data that is communicated from the state tool to executors via file. |