runner

Documentation

Index

• func GenerateID() string
• func Register(name string, ...)
• type Context
• type Runner
  • func Chain(runners ...Runner) Runner
  • func Lookup(ctx Context, payload map[string]interface{}) (Runner, error)

Functions

func GenerateID

func GenerateID() string

GenerateID creates a new ID.

func Register

func Register(name string, fn func(ctx Context, payload map[string]interface{}) (Runner, error))

Register registers a runner constructor.

Types

type Context

type Context interface {
	Name() string
	Environment() map[string]string
	ExpandAll(string) string
	ExpandVariables(string) string
	Workdir() string
	LogsFile() io.WriteSyncer
}

A Context carries the context of a Runner.

type Runner

type Runner interface {
	Run()
	Error() error
	IsErrorIgnored() bool
	AttachLogger(l logger.Logger)
}

A Runner is the action to be executed.

func Chain

func Chain(runners ...Runner) Runner

Chain wraps and runs sequentially the given runners.

func Lookup

func Lookup(ctx Context, payload map[string]interface{}) (Runner, error)

Lookup returns a new runner according given payload.