workflow

Documentation

Index

• type Job
  • func NewJob() *Job
  • func (j *Job) AppendTask(t Task)
  • func (j *Job) Run() error
  • func (j *Job) SetDataInitializer(build func() (RunData, error))
• type RunData
• type Task
  • func (t *Task) AppendTask(task Task)

Types

type Job

type Job struct {
	Tasks []Task
	// contains filtered or unexported fields
}

Job represents an executable workflow, it has list of tasks. these tasks must be execution order. if one of these tasks throws error, the entire job will fail. During the workflow,if there are some artifacts, we can store it to runData.

func NewJob

func NewJob() *Job

NewJob return a Job with task array.

func (*Job) AppendTask

func (j *Job) AppendTask(t Task)

AppendTask append a task to job, a job has a list of task.

func (*Job) Run

func (j *Job) Run() error

Run start execute job workflow. if the task has sub-task, it will recursive call the sub-tasks util all task be completed or error be thrown.

func (*Job) SetDataInitializer

func (j *Job) SetDataInitializer(build func() (RunData, error))

SetDataInitializer set a initialize runData function to job.

type RunData

type RunData = interface{}

RunData is an interface represents all of runDatas abstract object.

type Task

type Task struct {
	Name        string
	Run         func(RunData) error
	Skip        func(RunData) (bool, error)
	Tasks       []Task
	RunSubTasks bool
}

Task is minimum unit workflow. It is sample tree structure. we can set a list of sub-tasks, they will all be executed if RunSubTasks is true.

func (*Task) AppendTask

func (t *Task) AppendTask(task Task)

AppendTask append a sub task.