zuild

Documentation

Index

• Constants
• type Arg
• type Help
• type Task
  • func (t *Task) Actions(index map[string]int) action.Actions
• type TaskGraph
  • func NewTaskGraph() *TaskGraph
  • func (t *TaskGraph) Get(root string) ([]*Task, error)
  • func (t *TaskGraph) Populate(tasks []*Task)
• type Zuild
  • func New(cmd *cobra.Command, zi *ZuildFileInit) (*Zuild, error)
  • func (z *Zuild) Graph(task string) error
  • func (z *Zuild) List() error
  • func (z *Zuild) Run(task string) error
• type ZuildFile
  • func EvalZuildFile(zi *ZuildFileInit, ctx *hcl.EvalContext) (*ZuildFile, error)
• type ZuildFileInit
  • func ParseZuildFile(path string) (*ZuildFileInit, error)

Constants

const (
	DefaultTaskName = "default"
)

const (
	DefaultZfPath = "Zuildfile"
)

Types

type Arg

type Arg struct {
	Name  string `hcl:"name,label"`
	Short string `hcl:"short"`
	Usage string `hcl:"usage"`
}

type Help

type Help struct {
	Title   string `hcl:"title"`
	Content string `hcl:"content"`
}

type Task

type Task struct {
	Name    string       `hcl:"name,label"`
	Require []string     `hcl:"require,optional"`
	Sh      []*action.Sh `hcl:"Sh,block"`

	Config hcl.Body `hcl:",remain"`

	Node graph.Node
}

func (*Task) Actions

func (t *Task) Actions(index map[string]int) action.Actions

type TaskGraph

type TaskGraph struct {
	// contains filtered or unexported fields
}

func NewTaskGraph

func NewTaskGraph() *TaskGraph

func (*TaskGraph) Get

func (t *TaskGraph) Get(root string) ([]*Task, error)

func (*TaskGraph) Populate

func (t *TaskGraph) Populate(tasks []*Task)

type Zuild

type Zuild struct {
	*emission.Emitter
	// contains filtered or unexported fields
}

func New

func New(cmd *cobra.Command, zi *ZuildFileInit) (*Zuild, error)

func (*Zuild) Graph

func (z *Zuild) Graph(task string) error

func (*Zuild) List

func (z *Zuild) List() error

func (*Zuild) Run

func (z *Zuild) Run(task string) error

type ZuildFile

type ZuildFile struct {
	Help   *Help    `hcl:"Help,block"`
	Args   []*Arg   `hcl:"Arg,block"`
	Tasks  []*Task  `hcl:"Task,block"`
	Remain hcl.Body `hcl:",remain"`
	// contains filtered or unexported fields
}

func EvalZuildFile

func EvalZuildFile(zi *ZuildFileInit, ctx *hcl.EvalContext) (*ZuildFile, error)

type ZuildFileInit

type ZuildFileInit struct {
	Help *Help  `hcl:"Help,block"`
	Args []*Arg `hcl:"Arg,block"`

	Remain hcl.Body `hcl:",remain"`
	// contains filtered or unexported fields
}

func ParseZuildFile

func ParseZuildFile(path string) (*ZuildFileInit, error)