Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrWrongConfig is returned when an action has missing mandatory attributes. ErrWrongConfig = errors.New("wrong action configuration") )
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action struct {
Title string
Changelog string
PipelineReport string
Config Config
Scm *scm.Scm
Handler ActionHandler
}
Action is a struct used by an updatecli pipeline.
type ActionHandler ¶
ActionHandler interface defines required functions to be an action
type Config ¶
type Config struct {
// Title defines the action title
Title string `yaml:",omitempty"`
// Kind defines the action `kind` which affects accepted "spec" values
Kind string `yaml:",omitempty"`
// Spec defines parameters for a specific "kind"
Spec interface{} `yaml:",omitempty"`
// scmid references a scm configuration defined within the updatecli manifest
ScmID string `yaml:",omitempty"`
// !Deprecated in favor of `scmid`
DeprecatedScmID string `yaml:"scmID,omitempty" jsonschema:"-"`
}
Config define action provided via an updatecli configuration
func (Config) JSONSchema ¶
JSONSchema implements the json schema interface to generate the "action" jsonschema
Click to show internal directories.
Click to hide internal directories.