source

Documentation

Index

• Variables
• type Config
  • func (Config) JSONSchema() *jschema.Schema
  • func (c *Config) Validate() error
• type Source
  • func (s *Source) Run() (err error)

Variables

var (
	// ErrWrongConfig is returned when a condition spec has missing attributes which are mandatory
	ErrWrongConfig = errors.New("wrong source configuration")
)

Types

type Config

type Config struct {
	resource.ResourceConfig `yaml:",inline"`
}

Config struct defines a source configuration

func (Config) JSONSchema

func (Config) JSONSchema() *jschema.Schema

JSONSchema implements the json schema interface to generate the "source" jsonschema.

func (*Config) Validate

func (c *Config) Validate() error

Validate checks if a source configuration is valid

type Source

type Source struct {
	// Changelog holds the changelog description
	Changelog string
	// Result stores the source result after a source run.
	Result result.Source
	// Output contains the value retrieved from a source
	Output string
	// Config defines a source specifications
	Config Config
	// Scm stores scm information
	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