Deprecated: This module has moved to github.com/happy-sdk/lib/taskrunner. module github.com/happy-sdk/taskrunner

taskrunner

package module

v0.3.0 Latest Latest Go to latest Published: Mar 4, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Details

License: Apache-2.0
Created: 01.03.2025
Copyright: 2025 The Happy Authors

This section is empty.

View Source

var (
	Error = errors.New("taskrunner")
)

This section is empty.

type Action func() (res Result)

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

func NewGroup(title string) *Group

func (g *Group) Task(name string, action Action) uuid.UUID

func (g *Group) TaskD(name string, dependency string, action Action) uuid.UUID

TaskD adds task which depends on another tasks to be succsessful

type Result struct {
	Status     string
	State      State
	Decription string
	// contains filtered or unexported fields
}

func Failure(status, desc string) Result

Failure utility function to create Result with state FAILURE

func Success(status, desc string) Result

Success utility function to create Result with state SUCCESS

func Warn(status, desc string) Result

Warn utility function to create Result with state WARNING

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

func New(title string) *Runner

func (r *Runner) Add(group *Group) error

func (r *Runner) Run(what string) error

Run executes all tasks based on what pattern <group>.<task>

func (r *Runner) WithColors(colors branding.ColorPalette) *Runner

type State uint

const (
	INFO State = iota
	SUCCESS
	WARNING
	FAILURE
	SKIPPED
)

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