schedule

Documentation

Index

• type Result
• type Scheduler
  • func New() *Scheduler
  • func (s *Scheduler) NewTask(name, command string, deps []string) task.Task
  • func (s *Scheduler) Start(workers int, executor exec.Executor) Result
• type TaskResult
  • func (ta TaskResult) String() string
• type TaskStatus
  • func (ts TaskStatus) String() string

Types

type Result

type Result interface {
	// Errors contains the results of tasks with errors.
	Errors() []TaskResult
	// Ok is true if there were no errors.
	Ok() bool
}

Result is the result of the whole build.

type Scheduler

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

Scheduler takes a list of tasks and schedules their execution according to their dependencies.

func New

func New() *Scheduler

New creates a new scheduler.

func (*Scheduler) NewTask

func (s *Scheduler) NewTask(name, command string, deps []string) task.Task

NewTask adds a new task to this scheduler and returns it.

func (*Scheduler) Start

func (s *Scheduler) Start(workers int, executor exec.Executor) Result

Start the scheduler. Scheduler calls executor.Run(t Task) when t can be executed and returns when the whole task network has been processed.

type TaskResult

type TaskResult struct {
	Task   task.Task
	Err    error
	Status TaskStatus
}

TaskResult is the result of a single task.

func (TaskResult) String

func (ta TaskResult) String() string

type TaskStatus

type TaskStatus int

TaskStatus is the status of a task in a build.

const (
	// NotRun indicates a task was not run.
	NotRun TaskStatus = iota
	// Ok indicates a task was run with no error.
	Ok
	// Error indicates a task was run, but resulted in an error.
	Error
)

func (TaskStatus) String

func (ts TaskStatus) String() string