Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ShuttleAction ¶
type ShuttleAction struct {
Shell string `yaml:"shell"`
Dockerfile string `yaml:"dockerfile"`
Task string `yaml:"task"`
}
ShuttleAction describes an action done by a shuttle script
type ShuttleConfig ¶
type ShuttleConfig struct {
Plan string `yaml:"-"`
PlanRaw interface{} `yaml:"plan"`
Variables DynamicYaml `yaml:"vars"`
Scripts map[string]ShuttlePlanScript `yaml:"scripts"`
}
ShuttleConfig describes the actual config for each project
type ShuttlePlan ¶
type ShuttlePlan struct {
ProjectPath string
LocalPlanPath string
Configuration ShuttlePlanConfiguration
}
ShuttlePlan struct describes a plan
type ShuttlePlanConfiguration ¶
type ShuttlePlanConfiguration struct {
Vars map[string]interface{} `yaml:"vars"`
Documentation string `yaml:"documentation"`
Scripts map[string]ShuttlePlanScript `yaml:"scripts"`
}
ShuttlePlanConfiguration is a ShuttlePlan sub-element
func (*ShuttlePlanConfiguration) Load ¶
func (p *ShuttlePlanConfiguration) Load(planPath string) (*ShuttlePlanConfiguration, error)
Load loads a plan from project path and shuttle config
type ShuttlePlanScript ¶
type ShuttlePlanScript struct {
Description string `yaml:"description"`
Actions []ShuttleAction `yaml:"actions"`
Args []ShuttleScriptArgs `yaml:"args"`
}
ShuttlePlanScript is a ShuttlePlan sub-element
type ShuttleProjectContext ¶
type ShuttleProjectContext struct {
ProjectPath string
LocalShuttleDirectoryPath string
TempDirectoryPath string
Config ShuttleConfig
LocalPlanPath string
Plan ShuttlePlanConfiguration
Scripts map[string]ShuttlePlanScript
UI *ui.UI
}
ShuttleProjectContext describes the context of the project using shuttle
func (*ShuttleProjectContext) DocumentationURL ¶
func (p *ShuttleProjectContext) DocumentationURL() (string, error)
DocumentationURL returns a URL pointing to plan documentation if any is available. Plan reference and plan documentation field is inspected and parsed.
type ShuttleScriptArgs ¶
type ShuttleScriptArgs struct {
Name string `yaml:"name"`
Required bool `yaml:"required"`
Description string `yaml:"description"`
}
ShuttleScriptArgs describes an arguments that a script accepts
func (ShuttleScriptArgs) String ¶
func (a ShuttleScriptArgs) String() string
Click to show internal directories.
Click to hide internal directories.