task

Documentation

Index

• type Option
  • func Args(args map[string]interface{}) Option
  • func Log(log *log.Logger) Option
  • func Variables(vars map[string]string) Option
• type Task
  • func (t *Task) ID(id ...string) string
  • func (t *Task) Options(opts ...Option)
  • func (t *Task) Prepare() error
  • func (t *Task) PrintUsage(id string)
  • func (t *Task) UpToDate(ctx context.Context) bool

Types

type Option

type Option func(*Task)

Option configures a runtime option.

func Args

func Args(args map[string]interface{}) Option

Args returns an option configured with a args value.

func Log

func Log(log *log.Logger) Option

Log returns an option configured with a log value.

func Variables

func Variables(vars map[string]string) Option

Variables returns an option configured with a variables value.

type Task

type Task struct {
	Args      map[string]interface{}
	Commands  yaml2.List
	Deps      []string
	Dir       string
	Docker    *config.Docker
	Interval  string
	Summary   string
	Status    yaml2.List
	Tasks     yaml2.List
	Usage     string
	Variables map[string]string
	// contains filtered or unexported fields
}

Task represents a task.

func (*Task) ID

func (t *Task) ID(id ...string) string

ID returns the task id.

func (*Task) Options

func (t *Task) Options(opts ...Option)

Options sets task options.

func (*Task) Prepare

func (t *Task) Prepare() error

Prepare prepares the command and directory.

func (*Task) PrintUsage

func (t *Task) PrintUsage(id string)

PrintUsage print usage of task.

func (*Task) UpToDate

func (t *Task) UpToDate(ctx context.Context) bool

UpToDate determine if a task is up to date using status commands.