saku

package

v1.2.4 Latest Latest Go to latest Published: Nov 3, 2020 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

View Source

const Version = "1.2.3"

Version is the version number of saku.

This section is empty.

This section is empty.

type ExitCode int

ExitCode is the exit code of saku's Run function

const (
	ExitCodeOk ExitCode = iota
	ExitCodeError
)

The exit codes

func Run(cwd string, args ...string) ExitCode

Run saku command in the given cwd and arguments

type RunMode string

RunMode represents the mode of running multiple tasks

const (
	RunModeSequence     RunMode = "sequence"
	RunModeParallel     RunMode = "parallel"
	RunModeParallelRace RunMode = "parallel-race"
)

The run modes

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

TaskCollection is the model of the list of tasks.

func ParseConfig(config *[]byte) *TaskCollection

ParseConfig parses the given config markdown and returns tasks.

func (tc *TaskCollection) Run(ctx *runContext, stack *taskStack) error

Run runs the tasks.

func (tc *TaskCollection) SetRunMode(mode RunMode)

SetRunMode sets the run mode of the collection.