TaskConf

Describes a "task", part of the graph that dev-loop builds to know how to turn a command into something runnable.

  • name: String [REQUIRED]

The name of the task. This needs to be unique across the entire project.

  • type: String [OPTIONAL]

The type of task this is. Currently there are three supported options command, oneof, and pipeline. If you do not specify a type command will be assumed.

  • description: String [OPTIONAL]

The description of this task. This will be used when showing the task inside of a list command.

  • location: LocationConf [REQUIRED for "command" type tasks][IGNORED for "oneof"/"pipeline" tasks]

The location of the shell script to run when this task is a "command" type (the location being relative to wherever this task is defined). If specified on a oneof/pipeline task it will have no effect.

A list of things this task needs. This is how you can select a particular executor. If you've specified a custom_executor these will have no effect. If you don't specify these, or a custom_executor the Default Executor will be selected if it exists.

Represents a custom executor for this one task. In general we don't recommend setting this, and just defining it inside an executors configuration file. However there may be specific cases where you want to make it clear this task has needs for a very special executor. A custom_executor will always be selected if specified, and can still be reused within a pipeline.

  • steps: List[PipelineStep][REQUIRED for "pipeline" type tasks] [IGNORED for "command"/"oneof" tasks]

An ordered list of steps to run when running a pipeline. If specified on a command/oneof task it will have no effect.

  • options: List[OneofOption][REQUIRED for "oneof" type tasks] [IGNORED for "command"/"pipeline" tasks]

A list of options to potentially choose from when the task is a oneof type. If specified on a command/pipeline task it will have no effect.

  • tags: List[String][OPTIONAL]

A list of tags to apply to this task. Tags can be selected by presets in order to run multiple things at a time.

  • internal: Bool [OPTIONAL]

Whether or not this task is "internal". If a task is internal it will not be shown on any list command, and cannot be run directly (it must be invoked through a oneof/pipeline). All internal tasks must be used at least once, or an error will occur because it would be impossible for that task to do anything.

Edit this page