stages

Documentation

Overview

Package stages contains the stages api.

Index

• type Stage
  • func (s *Stage) Execute(path string, logger *gomol.LogAdapter, taskMap map[string]tasks.Task, ...) error
  • func (s *Stage) ShouldRun(err error) bool
  • func (s *Stage) UnmarshalYAML(unmarshal func(interface{}) error) error

Types

type Stage

type Stage struct {
	Name        string             `yaml:"name"`
	Run         string             `yaml:"run"`
	Environment yaml.StringOrSlice `yaml:"environment"`
	Tasks       yaml.StringOrSlice `yaml:"tasks"`
	Enabled     bool               `yaml:"enabled"`
	Always      bool               `yaml:"always"`
	Concurrent  bool               `yaml:"concurrent"`
}

Stage is a representation of a stage.

func (*Stage) Execute

func (s *Stage) Execute(path string, logger *gomol.LogAdapter, taskMap map[string]tasks.Task, env []string, st *state.State) error

Execute runs the stage.

func (*Stage) ShouldRun

func (s *Stage) ShouldRun(err error) bool

ShouldRun will return True if a stage should be run based on the passed in error (from the plan) and whether or not the stage is enabled.

func (*Stage) UnmarshalYAML

func (s *Stage) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML is a custom yaml unmarshaller for stages.