Documentation
¶
Overview ¶
Package plans holds the predefined kinds of plan: for each, what one run of such a plan does, for the plan manager to run inside a run's bookkeeping.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Command ¶
type Command struct {
// contains filtered or unexported fields
}
Command is a plan of entity.PlanKindCommand: each run is the plan's jobs.Command.
func NewCommand ¶
NewCommand reads a command plan, whose Params is a jobs.Command; its Out is the plan manager's, set for each run.
type Outcome ¶
type Outcome struct {
State entity.PlanRunState
Error string // why it failed, or what stopped it
ExitCode int // for a kind with an exit status, like a command; 0 for one without
}
Outcome is the part of a PlanRun that the plan's kind decides as one of its runs ends; the plan manager fills in the rest. Every kind gives a State and, unless it succeeded, an Error.
Click to show internal directories.
Click to hide internal directories.