runners

Documentation

Overview

Package runners contains all of the runners for convey.

Index

• type Default
  • func (d *Default) Run(cfg *config.Config, plans []string, env []string, st *state.State) int
• type Graphviz
  • func (g *Graphviz) Run(cfg *config.Config, plans []string, env []string, st *state.State) int
• type ListEnvironment
  • func (l *ListEnvironment) Run(cfg *config.Config, plans []string, env []string, st *state.State) int
• type ListMetaPlans
  • func (l *ListMetaPlans) Run(cfg *config.Config, plans []string, env []string, st *state.State) int
• type ListPlans
  • func (l *ListPlans) Run(cfg *config.Config, plans []string, env []string, st *state.State) int
• type ListTasks
  • func (l *ListTasks) Run(cfg *config.Config, plans []string, env []string, st *state.State) int
• type Runner
• type ShowConfig
  • func (sc *ShowConfig) Run(cfg *config.Config, plans []string, env []string, st *state.State) int

Types

type Default

type Default struct{}

Default is the normal Convey Runner.

func (*Default) Run

func (d *Default) Run(cfg *config.Config, plans []string, env []string, st *state.State) int

Run runs the Convey Runner.

type Graphviz

type Graphviz struct{}

Graphviz is a Runner that will create a graphviz output for the config that has been loaded.

func (*Graphviz) Run

func (g *Graphviz) Run(cfg *config.Config, plans []string, env []string, st *state.State) int

Run runs the graphviz runner.

type ListEnvironment

type ListEnvironment struct{}

ListEnvironment is a runner that will output the environment.

func (*ListEnvironment) Run

func (l *ListEnvironment) Run(cfg *config.Config, plans []string, env []string, st *state.State) int

Run runs the ListEnvironment runner.

type ListMetaPlans

type ListMetaPlans struct{}

ListMetaPlans is a Runner that outputs the metaplans for the loaded config.

func (*ListMetaPlans) Run

func (l *ListMetaPlans) Run(cfg *config.Config, plans []string, env []string, st *state.State) int

Run runs the ListMetaPlans runner.

type ListPlans

type ListPlans struct{}

ListPlans is a Runner that outputs the plans in the loaded config.

func (*ListPlans) Run

func (l *ListPlans) Run(cfg *config.Config, plans []string, env []string, st *state.State) int

Run runs the ListPlans Runner.

type ListTasks

type ListTasks struct{}

ListTasks is a Runner that will output the tasks defined in a config.

func (*ListTasks) Run

func (l *ListTasks) Run(cfg *config.Config, plans []string, env []string, st *state.State) int

Run runs the ListTasks runner.

type Runner

type Runner interface {
	Run(cfg *config.Config, plan []string, env []string, st *state.State) int
}

Runner is an interface for defining something that convey can run.

type ShowConfig

type ShowConfig struct{}

ShowConfig is a Runner that will dump the config to stdout.

func (*ShowConfig) Run

func (sc *ShowConfig) Run(cfg *config.Config, plans []string, env []string, st *state.State) int

Run runs the ShowConfig runner.