spec

Documentation

Index

• type Action
  • func (a Action) Execute(context exec.Context) error
  • func (a Action) String() string
• type ActionMap
• type Spec
  • func Load(templateDir string) (*Spec, error)

Types

type Action

type Action struct {
	Name  string
	Steps exec.Executables
}

Action represents a named executable that can be invoked from the command line via "jen do XXX" or via a "do" step

func (Action) Execute

func (a Action) Execute(context exec.Context) error

Execute executes many steps in sequence

func (Action) String

func (a Action) String() string

type ActionMap

type ActionMap map[string]Action

ActionMap represents a dictionary mapping action names to their corresponding action

type Spec

type Spec struct {
	Name         string
	Version      string
	Description  string
	Placeholders map[string]string
	Actions      map[string]Action
}

Spec represents a template specification file found in the root of the template's dir

func Load

func Load(templateDir string) (*Spec, error)

Load loads spec object from a template directory