Documentation
¶
Index ¶
- Constants
- Variables
- func Merge(t1, t2 *Taskfile, includedTaskfile *IncludedTaskfile, namespaces ...string) error
- type Call
- type Cmd
- type Dep
- type ErrInvalidPlatform
- type IncludedTaskfile
- type IncludedTaskfiles
- type Location
- type Output
- type OutputGroup
- type Platform
- type Precondition
- type Requires
- type Task
- type Taskfile
- type Tasks
- type Var
- type Vars
Constants ¶
const NamespaceSeparator = ":"
NamespaceSeparator contains the character that separates namespaces
Variables ¶
var ( V3 = semver.MustParse("3") V2 = semver.MustParse("2") )
var ErrCantUnmarshalPrecondition = errors.New("task: Can't unmarshal precondition value")
ErrCantUnmarshalPrecondition is returned for invalid precond YAML.
Functions ¶
Types ¶
type Call ¶
type Call struct {
Task string
Vars *Vars
Envs *Vars
Silent bool
Direct bool // Was the task called directly or via another task?
}
Call is the parameters to a task call
type Cmd ¶
type Cmd struct {
Cmd string
Silent bool
Task string
Set []string
Shopt []string
Vars *Vars
IgnoreError bool
Defer bool
Platforms []*Platform
}
Cmd is a task command
func (*Cmd) UnmarshalYAML ¶
type ErrInvalidPlatform ¶
type ErrInvalidPlatform struct {
Platform string
}
func (*ErrInvalidPlatform) Error ¶
func (err *ErrInvalidPlatform) Error() string
type IncludedTaskfile ¶
type IncludedTaskfile struct {
Taskfile string
Dir string
Optional bool
Internal bool
Aliases []string
AdvancedImport bool
Vars *Vars
BaseDir string // The directory from which the including taskfile was loaded; used to resolve relative paths
}
IncludedTaskfile represents information about included taskfiles
func (*IncludedTaskfile) DeepCopy ¶
func (it *IncludedTaskfile) DeepCopy() *IncludedTaskfile
DeepCopy creates a new instance of IncludedTaskfile and copies data by value from the source struct.
func (*IncludedTaskfile) FullDirPath ¶
func (it *IncludedTaskfile) FullDirPath() (string, error)
FullDirPath returns the fully qualified path to the included taskfile's working directory
func (*IncludedTaskfile) FullTaskfilePath ¶
func (it *IncludedTaskfile) FullTaskfilePath() (string, error)
FullTaskfilePath returns the fully qualified path to the included taskfile
func (*IncludedTaskfile) UnmarshalYAML ¶
func (it *IncludedTaskfile) UnmarshalYAML(node *yaml.Node) error
type IncludedTaskfiles ¶
type IncludedTaskfiles struct {
Keys []string
Mapping map[string]IncludedTaskfile
}
IncludedTaskfiles represents information about included tasksfiles
func (*IncludedTaskfiles) Len ¶
func (tfs *IncludedTaskfiles) Len() int
Len returns the length of the map
func (*IncludedTaskfiles) Range ¶
func (tfs *IncludedTaskfiles) Range(yield func(key string, includedTaskfile IncludedTaskfile) error) error
Range allows you to loop into the included taskfiles in its right order
func (*IncludedTaskfiles) Set ¶
func (tfs *IncludedTaskfiles) Set(key string, includedTaskfile IncludedTaskfile)
Set sets a value to a given key
func (*IncludedTaskfiles) UnmarshalYAML ¶
func (tfs *IncludedTaskfiles) UnmarshalYAML(node *yaml.Node) error
UnmarshalYAML implements the yaml.Unmarshaler interface.
type Output ¶
type Output struct {
// Name of the Output.
Name string `yaml:"-"`
// Group specific style
Group OutputGroup
}
Output of the Task output
func (*Output) UnmarshalYAML ¶
type OutputGroup ¶
OutputGroup is the style options specific to the Group style.
func (*OutputGroup) IsSet ¶
func (g *OutputGroup) IsSet() bool
IsSet returns true if and only if a custom output style is set.
type Platform ¶
Platform represents GOOS and GOARCH values
func (*Platform) UnmarshalYAML ¶
UnmarshalYAML implements yaml.Unmarshaler interface.
type Precondition ¶
Precondition represents a precondition necessary for a task to run
func (*Precondition) DeepCopy ¶
func (p *Precondition) DeepCopy() *Precondition
func (*Precondition) UnmarshalYAML ¶
func (p *Precondition) UnmarshalYAML(node *yaml.Node) error
UnmarshalYAML implements yaml.Unmarshaler interface.
type Requires ¶
type Requires struct {
Vars []string
}
Requires represents a set of required variables necessary for a task to run
type Task ¶
type Task struct {
Task string
Cmds []*Cmd
Deps []*Dep
Label string
Desc string
Prompt string
Summary string
Requires *Requires
Aliases []string
Sources []string
Generates []string
Status []string
Preconditions []*Precondition
Dir string
Set []string
Shopt []string
Vars *Vars
Env *Vars
Dotenv []string
Silent bool
Interactive bool
Internal bool
Method string
Prefix string
IgnoreError bool
Run string
IncludeVars *Vars
IncludedTaskfileVars *Vars
IncludedTaskfile *IncludedTaskfile
Platforms []*Platform
Location *Location
}
Task represents a task
func (*Task) DeepCopy ¶
DeepCopy creates a new instance of Task and copies data by value from the source struct.
func (*Task) UnmarshalYAML ¶
type Taskfile ¶
type Taskfile struct {
Location string
Version *semver.Version
Expansions int
Output Output
Method string
Includes *IncludedTaskfiles
Set []string
Shopt []string
Vars *Vars
Env *Vars
Tasks Tasks
Silent bool
Dotenv []string
Run string
Interval time.Duration
}
Taskfile represents a Taskfile.yml
func (*Taskfile) UnmarshalYAML ¶
type Tasks ¶
type Tasks struct {
orderedmap.OrderedMap[string, *Task]
}
Tasks represents a group of tasks
func (*Tasks) UnmarshalYAML ¶
type Vars ¶
type Vars struct {
orderedmap.OrderedMap[string, Var]
}
Vars is a string[string] variables map.
func (*Vars) DeepCopy ¶
DeepCopy creates a new instance of Vars and copies data by value from the source struct.
func (*Vars) ToCacheMap ¶
ToCacheMap converts Vars to a map containing only the static variables
Source Files
Directories