source

Documentation

Index

• type Config
• type Replacer
• type Replacers
  • func (replacers Replacers) Unmarshal() (result []string)
• type Source
  • func (s *Source) Run() (err error)

Types

type Config

type Config struct {
	resource.ResourceConfig `yaml:",inline"`
	Replaces                Replacers // Deprecated in favor of Transformers on 2021/01/3
}

Config struct defines a source configuration

type Replacer

type Replacer struct {
	From string
	To   string
}

Replacer is struct used to feed strings.Replacer

type Replacers

type Replacers []Replacer

Replacers is an array of Replacer

func (Replacers) Unmarshal

func (replacers Replacers) Unmarshal() (result []string)

Unmarshal read a struct of Replacers then return a slice of string

type Source

type Source struct {
	Changelog string // Changelog holds the changelog description
	Result    string // Result stores the source result after a source run. This variable can't be set by an updatecli configuration
	Output    string // Output contains the value retrieved from a source
	Config    Config // Config defines a source specifications
	Scm       *scm.ScmHandler
}

Source defines how a value is retrieved from a specific source

func (*Source) Run

func (s *Source) Run() (err error)

Run execute actions defined by the source configuration