taskfile

package

v2.8.2-0...-527a482 Latest Latest Go to latest Published: Aug 12, 2020 License: MIT Imports: 3 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

Repository

github.com/damian-szulc/task

Documentation ¶

Index ¶

Constants
Variables
func Merge(t1, t2 *Taskfile, namespaces ...string) error
type Call
type Cmd
- func (c *Cmd) UnmarshalYAML(unmarshal func(interface{}) error) error
type Dep
- func (d *Dep) UnmarshalYAML(unmarshal func(interface{}) error) error
type Precondition
- func (p *Precondition) UnmarshalYAML(unmarshal func(interface{}) error) error
type Task
type Taskfile
- func (tf *Taskfile) UnmarshalYAML(unmarshal func(interface{}) error) error
type Tasks
type Var
- func (v *Var) UnmarshalYAML(unmarshal func(interface{}) error) error
type Vars
- func (vs Vars) ToStringMap() (m map[string]string)

Constants ¶

View Source

const NamespaceSeparator = ":"

NamespaceSeparator contains the character that separates namescapes

Variables ¶

View Source

var (
	// ErrCantUnmarshalCmd is returned for invalid command YAML
	ErrCantUnmarshalCmd = errors.New("task: can't unmarshal cmd value")
	// ErrCantUnmarshalDep is returned for invalid dependency YAML
	ErrCantUnmarshalDep = errors.New("task: can't unmarshal dep value")
)

View Source

var (
	// ErrCantUnmarshalPrecondition is returned for invalid precond YAML.
	ErrCantUnmarshalPrecondition = errors.New("task: Can't unmarshal precondition value")
)

View Source

var (
	// ErrCantUnmarshalVar is returned for invalid var YAML.
	ErrCantUnmarshalVar = errors.New("task: can't unmarshal var value")
)

Functions ¶

func Merge ¶

func Merge(t1, t2 *Taskfile, namespaces ...string) error

Merge merges the second Taskfile into the first

Types ¶

type Call ¶

type Call struct {
	Task string
	Vars Vars
}

Call is the parameters to a task call

type Cmd ¶

type Cmd struct {
	Cmd         string
	Silent      bool
	Task        string
	Vars        Vars
	IgnoreError bool
}

Cmd is a task command

func (*Cmd) UnmarshalYAML ¶

func (c *Cmd) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface

type Dep ¶

type Dep struct {
	Task string
	Vars Vars
}

Dep is a task dependency

func (*Dep) UnmarshalYAML ¶

func (d *Dep) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface

type Precondition ¶

type Precondition struct {
	Sh  string
	Msg string
}

Precondition represents a precondition necessary for a task to run

func (*Precondition) UnmarshalYAML ¶

func (p *Precondition) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type Task ¶

type Task struct {
	Task          string
	Cmds          []*Cmd
	Deps          []*Dep
	Desc          string
	Summary       string
	Sources       []string
	Generates     []string
	Status        []string
	Preconditions []*Precondition
	Dir           string
	Vars          Vars
	Env           Vars
	Silent        bool
	Method        string
	Prefix        string
	IgnoreError   bool `yaml:"ignore_error"`
}

Task represents a task

type Taskfile ¶

type Taskfile struct {
	Version    string
	Expansions int
	Output     string
	Includes   map[string]string
	Vars       Vars
	Env        Vars
	Tasks      Tasks
	Silent     bool
}

Taskfile represents a Taskfile.yml

func (*Taskfile) UnmarshalYAML ¶

func (tf *Taskfile) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface

type Tasks ¶

type Tasks map[string]*Task

Tasks represents a group of tasks

type Var ¶

type Var struct {
	Static string
	Sh     string
}

Var represents either a static or dynamic variable.

func (*Var) UnmarshalYAML ¶

func (v *Var) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type Vars ¶

type Vars map[string]Var

Vars is a string[string] variables map.

func (Vars) ToStringMap ¶

func (vs Vars) ToStringMap() (m map[string]string)

ToStringMap converts Vars to a string map containing only the static variables

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
read

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL