engine

Documentation

Index

• Variables
• func Clone(s *scm.ScmHandler, channel chan int, hashes *[]uint64, wg *sync.WaitGroup) error
• func GenerateSchema(baseSchemaID, schemaDir string) error
• func GetFiles(root string) (files []string)
• type Engine
  • func (e *Engine) Clean() (err error)
  • func (e *Engine) InitSCM() (err error)
  • func (e *Engine) LoadAutoDiscovery() error
  • func (e *Engine) LoadConfigurations() error
  • func (e *Engine) ManifestUpgrade(saveToDisk bool) (err error)
  • func (e *Engine) Prepare() (err error)
  • func (e *Engine) Run() (err error)
  • func (e *Engine) Show() error
• type Options

Variables

var (
	// ErrNoManifestDetected is return when we couldn't find Updatecli manifest
	ErrNoManifestDetected error = errors.New("no Updatecli manifest detected")
)

Functions

func Clone

func Clone(
	s *scm.ScmHandler,
	channel chan int,
	hashes *[]uint64,
	wg *sync.WaitGroup) error

Clone parses a scm configuration then clone the git repository if needed.

func GenerateSchema

func GenerateSchema(baseSchemaID, schemaDir string) error

func GetFiles

func GetFiles(root string) (files []string)

GetFiles return an array with every valid files.

Types

type Engine

type Engine struct {
	Pipelines []pipeline.Pipeline
	Options   Options
	Reports   reports.Reports
	// contains filtered or unexported fields
}

Engine defined parameters for a specific engine run.

func (*Engine) Clean

func (e *Engine) Clean() (err error)

Clean remove every traces from an updatecli run.

func (*Engine) InitSCM

func (e *Engine) InitSCM() (err error)

InitSCM search and clone only once SCM configurations found.

func (*Engine) LoadAutoDiscovery

func (e *Engine) LoadAutoDiscovery() error

LoadAutoDiscovery will try to guess available pipelines based on specific directory

func (*Engine) LoadConfigurations

func (e *Engine) LoadConfigurations() error

ReadConfigurations read every strategies configuration.

func (*Engine) ManifestUpgrade

func (e *Engine) ManifestUpgrade(saveToDisk bool) (err error)

ManifestUpgrade load Updatecli Manifest to update them then written them back on disk

func (*Engine) Prepare

func (e *Engine) Prepare() (err error)

Prepare run every actions needed before going further.

func (*Engine) Run

func (e *Engine) Run() (err error)

Run runs the full process for one yaml file.

func (*Engine) Show

func (e *Engine) Show() error

Show displays configurations that should be apply.

type Options

type Options struct {
	Config   config.Option
	Pipeline pipeline.Options
}

Options defines application specific behaviors