Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrNoTasksHeading = errors.New("no xc block found")
ErrNoTasksHeading is returned if the markdown contains no xc block
Functions ¶
Types ¶
type AttributeType ¶
type AttributeType int
AttributeType represents metadata related to a Task.
# Tasks ## Task1 AttributeName: AttributeValue ``` script ```
const ( // AttributeTypeEnv sets the environment variables for a Task. // It can be represented by an attribute with name `environment` or `env`. AttributeTypeEnv AttributeType = iota // AttributeTypeDir sets the working directory for a Task. // It can be represented by an attribute with name `directory` or `dir`. AttributeTypeDir // AttributeTypeReq sets the required Tasks for a Task, they will run // prior to the execution of the selected task. // It can be represented by an attribute with name `requires` or `req`. AttributeTypeReq // AttributeTypeInp sets the required inputs for a Task, inputs can be provided // as commandline arguments or environment variables. AttributeTypeInp // AttributeTypeRun sets the tasks requiredBehaviour, can be always or once. // Default is always AttributeTypeRun // AttributeTypeRunDeps sets the tasks dependenciesBehaviour, can be sync or async. AttributeTypeRunDeps // AttributeTypeInteractive indicates if this is an interactive task // if it is, then logs are not prefixed and the stdout/stderr are passed directly // from the OS AttributeTypeInteractive )
Click to show internal directories.
Click to hide internal directories.