source

Documentation

Index

• type Changelog
• type Replacer
• type Replacers
  • func (replacers Replacers) Unmarshal() (result []string)
• type Source
  • func (s *Source) Execute() (output string, changelogContent string, err error)
  • func (s *Source) Unmarshal() (spec Spec, changelog Changelog, err error)
• type Spec

Types

type Changelog

type Changelog interface {
	Changelog(release string) (string, error)
}

Changelog is an interface to retrieve changelog description

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 {
	DependsOn    []string `yaml:"depends_on"` // DependsOn specify dag dependencies between sources
	Name         string
	Kind         string
	Prefix       string // Deprecated in favor of Transformers on 2021/01/3
	Postfix      string // Deprecated in favor of Transformers on 2021/01/3
	Transformers transformer.Transformers
	Replaces     Replacers // Deprecated in favor of Transformers on 2021/01/3
	Spec         interface{}
	Scm          map[string]interface{}
}

Source defines how a value is retrieved from a specific source

func (*Source) Execute

func (s *Source) Execute() (output string, changelogContent string, err error)

Execute execute actions defined by the source configuration

func (*Source) Unmarshal

func (s *Source) Unmarshal() (spec Spec, changelog Changelog, err error)

Unmarshal decode a source spec and returned its typed content

type Spec

type Spec interface {
	Source(workingDir string) (string, error)
}

Spec source is an interface to handle source spec