yaml

Documentation

Index

• type Yaml
  • func (y *Yaml) Condition(source string) (bool, error)
  • func (y *Yaml) ConditionFromSCM(source string, scm scm.Scm) (bool, error)
  • func (y *Yaml) Source(workingDir string) (string, error)
  • func (y *Yaml) Target(source string, dryRun bool) (changed bool, err error)
  • func (y *Yaml) TargetFromSCM(source string, scm scm.Scm, dryRun bool) (changed bool, files []string, message string, err error)

Types

type Yaml

type Yaml struct {
	File  string
	Key   string
	Path  string
	Value string
}

Yaml stores configuration about the file and the key value which needs to be updated.

func (*Yaml) Condition

func (y *Yaml) Condition(source string) (bool, error)

Condition checks if a key exists in a yaml file

func (*Yaml) ConditionFromSCM

func (y *Yaml) ConditionFromSCM(source string, scm scm.Scm) (bool, error)

ConditionFromSCM checks if a key exists in a yaml file

func (*Yaml) Source

func (y *Yaml) Source(workingDir string) (string, error)

Source return the latest version

func (*Yaml) Target

func (y *Yaml) Target(source string, dryRun bool) (changed bool, err error)

Target updates a scm repository based on the modified yaml file.

func (*Yaml) TargetFromSCM

func (y *Yaml) TargetFromSCM(source string, scm scm.Scm, dryRun bool) (changed bool, files []string, message string, err error)

TargetFromSCM updates a scm repository based on the modified yaml file.