plans

Documentation

Overview

Package plans contains the plans structure.

Index

• Variables
• type MetaPlan
  • func (m *MetaPlan) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Plan
  • func (p *Plan) Execute(path string, tasks map[string]tasks.Task, env []string, st *state.State) error
  • func (p *Plan) Valid() error

Variables

var (
	// ErrNoStages is an error that can be returned from Plan.Valid.
	ErrNoStages = errors.New("no stages found")
)

Types

type MetaPlan

type MetaPlan struct {
	Plans []string `yaml:"plans"`
}

MetaPlan is a representation of a meta plan.

func (*MetaPlan) UnmarshalYAML

func (m *MetaPlan) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML is a custom yaml unmarshaller for MetaPlan's.

type Plan

type Plan struct {
	Environment yaml.StringOrSlice `yaml:"environment"`
	Stages      []stages.Stage     `yaml:"stages"`
	Merge       bool               `yaml:"merge"`
}

Plan is the representation of a Plan.

func (*Plan) Execute

func (p *Plan) Execute(path string, tasks map[string]tasks.Task, env []string, st *state.State) error

Execute runs the plan.

func (*Plan) Valid

func (p *Plan) Valid() error

Valid validates the plan.