target

Documentation

Index

• type Config
• type Options
• type Target
  • func (t *Target) Check() (bool, error)
  • func (t *Target) Run(source string, o *Options) (err error)

Types

type Config

type Config struct {
	resource.ResourceConfig `yaml:",inline"`
	PipelineID              string `yaml:"pipelineID"` // PipelineID references a unique pipeline run allowing to group targets
	ReportTitle             string // ReportTitle contains the updatecli reports title for sources and conditions run
	ReportBody              string // ReportBody contains the updatecli reports body for sources and conditions run
	SourceID                string `yaml:"sourceID"`
}

Config defines target parameters

type Options

type Options struct {
	Commit bool
	Push   bool
	Clean  bool
	DryRun bool
}

Options hold target parameters

type Target

type Target struct {
	Result string // Result store the condition result after a target run. This variable can't be set by an updatecli configuration
	Config Config
	Commit bool
	Push   bool
	Clean  bool
	DryRun bool
	Scm    *scm.ScmHandler
}

Target defines which file needs to be updated based on source output

func (*Target) Check

func (t *Target) Check() (bool, error)

Check verifies if mandatory Targets parameters are provided and return false if not.

func (*Target) Run

func (t *Target) Run(source string, o *Options) (err error)

Run applies a specific target configuration