pipeline

Documentation

Index

• Variables
• func SortedConditionsKeys(conditions *map[string]condition.Condition) (result []string, err error)
• func SortedSourcesKeys(sources *map[string]source.Source) (result []string, err error)
• func SortedTargetsKeys(targets *map[string]target.Target) (result []string, err error)
• type Options
• type Pipeline
  • func (p *Pipeline) GetTargetsIDByResult(targetIDs []string) (...)
  • func (p *Pipeline) Init(config *config.Config, options Options) error
  • func (p *Pipeline) Run() error
  • func (p *Pipeline) RunActions() error
  • func (p *Pipeline) RunConditions() (err error)
  • func (p *Pipeline) RunSources() error
  • func (p *Pipeline) RunTargets() error
  • func (p *Pipeline) SearchAssociatedTargetsID(actionID string) ([]string, error)
  • func (p *Pipeline) String() string
  • func (p *Pipeline) Update() error

Variables

var (
	// ErrNotValidDependsOn is triggered when we define a nonexistent depends on value.
	ErrNotValidDependsOn = errors.New("no valid depends_on value")
	// ErrDependsOnLoopDetected is triggered when we define a dependency loop.
	ErrDependsOnLoopDetected = errors.New("dependency loop detected")
)

var (
	// ErrRunTargets is return when at least one error happened during targets execution
	ErrRunTargets error = errors.New("something went wrong during target execution")
)

Functions

func SortedConditionsKeys

func SortedConditionsKeys(conditions *map[string]condition.Condition) (result []string, err error)

SortedConditionsKeys return a a list of resources by building a DAG

func SortedSourcesKeys

func SortedSourcesKeys(sources *map[string]source.Source) (result []string, err error)

SortedSourcesKeys return a a list of resources by building a DAG

func SortedTargetsKeys

func SortedTargetsKeys(targets *map[string]target.Target) (result []string, err error)

SortedTargetsKeys return a a list of resources by building a DAG

Types

type Options

type Options struct {
	Target target.Options
}

type Pipeline

type Pipeline struct {
	// Name defines a pipeline name, used to improve human visualization
	Name string
	// ID allows to identify a full pipeline run, this value is propagated into each target if not defined at that level
	ID string
	// Sources contains all sources defined in the configuration
	Sources map[string]source.Source
	// Conditions contains all conditions defined in the configuration
	Conditions map[string]condition.Condition
	// Targets contains all targets defined in the configuration
	Targets map[string]target.Target
	// SCMs contains all scms defined in the configuration
	SCMs map[string]scm.Scm
	// Actions contains all actions defined in the configuration
	Actions map[string]action.Action
	// Report contains the pipeline report
	Report reports.Report
	// Options contains all updatecli options for this specific pipeline
	Options Options
	// Config contains the pipeline configuration defined by the user
	Config *config.Config
}

Pipeline represent an updatecli run for a specific configuration

func (*Pipeline) GetTargetsIDByResult

func (p *Pipeline) GetTargetsIDByResult(targetIDs []string) (
	failedTargetsID, attentionTargetsID, successTargetsID, skippedTargetsID []string)

GetTargetsIDByResult return a list of target ID per result type

func (*Pipeline) Init

func (p *Pipeline) Init(config *config.Config, options Options) error

Init initialize an updatecli context based on its configuration

func (*Pipeline) Run

func (p *Pipeline) Run() error

Run execute an single pipeline

func (*Pipeline) RunActions

func (p *Pipeline) RunActions() error

func (*Pipeline) RunConditions

func (p *Pipeline) RunConditions() (err error)

RunConditions run every conditions for a given configuration config.

func (*Pipeline) RunSources

func (p *Pipeline) RunSources() error

RunSources iterates on every source definition to retrieve every information.

func (*Pipeline) RunTargets

func (p *Pipeline) RunTargets() error

RunTargets iterates on every target to update each of them.

func (*Pipeline) SearchAssociatedTargetsID

func (p *Pipeline) SearchAssociatedTargetsID(actionID string) ([]string, error)

SearchAssociatedTargetsID search for targets related to an action based on a scm configuration

func (*Pipeline) String

func (p *Pipeline) String() string

func (*Pipeline) Update

func (p *Pipeline) Update() error