Documentation
¶
Index ¶
- Constants
- Variables
- type Authors
- type Command
- type Commands
- type DependsOn
- type Env
- type Excludes
- type Ignores
- type Includes
- type Input
- type Inputs
- type Paths
- type Plugin
- type Plugins
- type RunOpt
- type RunOpts
- type Spec
- type Step
- type Steps
- type Task
- type Tasks
- type Template
- type Templates
- type Vars
- type Watch
- type WorkingDir
Constants ¶
View Source
const (
DefaultFilename = ".run.yml"
)
DefaultFilename ...
Variables ¶
View Source
var (
ErrTaskNotFound = fmt.Errorf("task not found")
)
Functions ¶
This section is empty.
Types ¶
type Input ¶
type Input struct {
Name string `yaml:"name"`
Type string `yaml:"type"`
Prompt string `yaml:"prompt"`
Regex string `yaml:"regex"`
}
Input ...
type Plugin ¶
type Plugin struct {
Id string `yaml:"id"`
Name string `yaml:"name"`
Description string `yaml:"description"`
Path string `yaml:"path"`
}
Plugin ...
type RunOpts ¶
type RunOpts struct {
WorkingDir WorkingDir
Vars Vars
Env Env
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
}
RunOpts ...
type Spec ¶
type Spec struct {
// Spec ...
Spec int `validate:"required" yaml:"spec"`
// Version ...
Version string `validate:"required" yaml:"version,omitempty"`
// Description ...
Description string `yaml:"description,omitempty"`
// Authors ...
Authors Authors `validate:"required" yaml:"authors,omitempty"`
// Homepage ...
Homepage string `yaml:"homepage,omitempty"`
// License ...
License string `yaml:"license,omitempty"`
// Repository ...
Repository string `yaml:"repository,omitempty"`
// Plugins ...
Plugins Plugins `yaml:"plugins,omitempty"`
// Tasks ...
Tasks Tasks `yaml:"tasks"`
// Vars ...
Vars Vars `yaml:"vars"`
// Env ...
Env Env `yaml:"env"`
}
Spec ...
type Step ¶
type Step struct {
Cmd string `yaml:"cmd"`
ContinueOnError bool `yaml:"continue-on-error"`
Env Env `yaml:"env"`
Id string `yaml:"id"`
If string `yaml:"if"`
TimeoutInSeconds int64 `yaml:"timeout-in-seconds"`
Uses string `yaml:"uses"`
Vars Vars `yaml:"vars"`
With map[string]string `yaml:"with"`
WorkingDir WorkingDir `yaml:"working-dir"`
}
Step ...
type Task ¶
type Task struct {
If string `yaml:"if"`
Default bool `yaml:"default"`
DependsOn DependsOn `yaml:"depends-on"`
Name string `yaml:"name"`
Disabled bool `yaml:"disabled"`
Env Env `yaml:"env"`
Vars Vars `yaml:"vars"`
Templates Templates `yaml:"template,omitempty"`
Watch Watch `yaml:"watch"`
WorkingDir WorkingDir `yaml:"working-dir"`
Steps Steps `yaml:"steps"`
}
Task ...
type Watch ¶
type Watch struct {
Paths Paths `yaml:"paths,omitempty"`
Ignores Ignores `yaml:"ignores,omitempty"`
}
Watch ...
Click to show internal directories.
Click to hide internal directories.