runner

Documentation

Index

• Variables
• func Run(stp step.Step, opts Options) error
• type Error
  • func (err *Error) Error() string
• type Options

Variables

var NoOptions = Options{}

NoOptions are the default Options.

Functions

func Run

func Run(stp step.Step, opts Options) error

Run runs stp with the given opts.

Types

type Error

type Error struct {
	// Step is the step that caused the error.
	Step step.Step `json:"step,omitempty"`

	// Message is the error message.
	Message interface{} `json:"message,omitempty"`
}

Error is a custom error that occurs during the execution of a step.

func (*Error) Error

func (err *Error) Error() string

Error returns err's message prepended with a prefix.

type Options

type Options struct {
	Stdout io.Writer `json:"stdout,omitempty"`
	Stderr io.Writer `json:"stderr,omitempty"`
}