task

package module
v2.8.2-0...-527a482 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 12, 2020 License: MIT Imports: 30 Imported by: 0

README

Test GoReleaser

Task

Task is a task runner / build tool that aims to be simpler and easier to use than, for example, GNU Make.

See taskfile.dev for documentation.

Sponsors

Sponsors

Backers

Backers

Contributors

Contributors

Documentation

Index

Constants

View Source 
const (
	// MaximumTaskCall is the max number of times a task can be called.
	// This exists to prevent infinite loops on cyclic dependencies
	MaximumTaskCall = 100
)

Variables

View Source 
var (
	// ErrPreconditionFailed is returned when a precondition fails
	ErrPreconditionFailed = errors.New("task: precondition not met")
)
View Source 
var (
	// ErrTaskfileAlreadyExists is returned on creating a Taskfile if one already exists
	ErrTaskfileAlreadyExists = errors.New("task: A Taskfile already exists")
)

Functions

func InitTaskfile 

func InitTaskfile(w io.Writer, dir string) error

InitTaskfile Taskfile creates a new Taskfile

Types

type Executor 

type Executor struct {
	Taskfile *taskfile.Taskfile

	Dir        string
	Entrypoint string
	Force      bool
	Watch      bool
	Verbose    bool
	Silent     bool
	Dry        bool
	Summary    bool
	Parallel   bool

	Stdin  io.Reader
	Stdout io.Writer
	Stderr io.Writer

	Logger      *logger.Logger
	Compiler    compiler.Compiler
	Output      output.Output
	OutputStyle string
	// contains filtered or unexported fields
}

Executor executes a Taskfile

func (*Executor) CompiledTask 

func (e *Executor) CompiledTask(call taskfile.Call) (*taskfile.Task, error)

CompiledTask returns a copy of a task, but replacing variables in almost all properties using the Go template package.

func (*Executor) PrintTasksHelp 

func (e *Executor) PrintTasksHelp()

PrintTasksHelp prints help os tasks that have a description

func (*Executor) Run 

func (e *Executor) Run(ctx context.Context, calls ...taskfile.Call) error

Run runs Task

func (*Executor) RunTask 

func (e *Executor) RunTask(ctx context.Context, call taskfile.Call) error

RunTask runs a task by its name

func (*Executor) Setup 

func (e *Executor) Setup() error

Setup setups Executor's internal state

func (*Executor) Status 

func (e *Executor) Status(ctx context.Context, calls ...taskfile.Call) error

Status returns an error if any the of given tasks is not up-to-date

type MaximumTaskCallExceededError 

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

MaximumTaskCallExceededError is returned when a task is called too many times. In this case you probably have a cyclic dependendy or infinite loop

func (*MaximumTaskCallExceededError) Error 

func (e *MaximumTaskCallExceededError) Error() string

Source Files

View all Source files

Directories

Path Synopsis
cmd
task
internal
compiler
compiler/v1
compiler/v2
execext
logger
output
status
summary
templater
read

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.