result

Documentation

Index

• Constants
• type Condition
  • func (c *Condition) SetConsoleOutput(out *bytes.Buffer)
• type GitBranch
• type SCM
• type Source
  • func (s *Source) SetConsoleOutput(out *bytes.Buffer)
• type Target
  • func (t *Target) SetConsoleOutput(out *bytes.Buffer)
  • func (t *Target) String() string

Constants

const (
	SUCCESS   string = "\u2714"
	FAILURE   string = "\u2717"
	ATTENTION string = "\u26A0"
	SKIPPED   string = "-"
)

Types

type Condition

type Condition struct {
	//Name holds the condition name
	Name string
	/*
		Result holds the condition result, accepted values must be one:
			* "SUCCESS"
			* "FAILURE"
			* "ATTENTION"
			* "SKIPPED"
	*/
	Result string
	// Pass stores the information detected by the condition execution.
	Pass bool
	// Description stores the condition execution description.
	Description string
	// Scm stores scm information
	Scm SCM
	// ID contains a uniq identifier for the condition
	ID string
	// ConsoleOutput stores the console output of the condition execution
	ConsoleOutput string
}

Conditions holds condition execution result

func (*Condition) SetConsoleOutput

func (c *Condition) SetConsoleOutput(out *bytes.Buffer)

SetConsoleOutput sets the console output of the condition execution

type GitBranch

type GitBranch struct {
	// Source defines the branch used as a source
	Source string
	// Working defines the working branch used by Updatecli
	Working string
	// Target defines the branch used by Updatecli to apply the changes done from the working branch
	Target string
}

type SCM

type SCM struct {
	// URL defines the git URL
	URL string
	// Branch defines the different branches used by Updatecli
	Branch GitBranch
	// ID contains a uniq identifier for the scm
	ID string
	// BranchReset defines if the scm branch was reset to the base branch during the pipeline execution
	BranchReset bool
}

SCM defines scm information

type Source

type Source struct {
	// Name holds the source name
	Name string
	/*
		Result holds the source result, accepted values must be one:
			* "SUCCESS"
			* "FAILURE"
			* "ATTENTION"
			* "SKIPPED"
	*/
	Result string
	// Information stores the information detected by the source execution such as a version
	Information string
	// Description stores the source execution description
	Description string
	// Scm stores scm information
	Scm SCM
	// ID contains a uniq identifier for the source
	ID string
	//Changelog holds the changelog description
	Changelog string
	// ConsoleOutput stores the console output of the source execution
	ConsoleOutput string
}

Source holds source execution result

func (*Source) SetConsoleOutput

func (s *Source) SetConsoleOutput(out *bytes.Buffer)

SetConsoleOutput sets the console output of the source execution

type Target

type Target struct {
	// Name holds the target name
	Name string
	// DryRun defines if a target was executed in DryRun mode
	DryRun bool
	/*
		Result holds the target result, accepted values must be one:
			* "SUCCESS"
			* "FAILURE"
			* "ATTENTION"
			* "SKIPPED"
	*/
	Result string
	// Information stores the old information detected by the target execution
	Information string
	// NewInformation stores the new information updated by during the target execution
	NewInformation string
	// Description stores the target execution description
	Description string
	// Files holds the list of files modified by a target execution
	Files []string
	// Changed specifies if the target was modify during the pipeline execution
	Changed bool
	// Scm stores scm information
	Scm SCM
	// ID contains a uniq identifier for the target
	ID string
	// ConsoleOutput stores the console output of the target execution
	ConsoleOutput string
}

Target holds target execution result

func (*Target) SetConsoleOutput

func (t *Target) SetConsoleOutput(out *bytes.Buffer)

SetConsoleOutput sets the console output of the target execution

func (*Target) String

func (t *Target) String() string