This topic lists tags that can be used with Matrix Pipeline steps. For more information on Matrix for Pipelines steps, see Matrix.
name
An alphanumeric string (underscores are permitted) that identifies the step.
type
Must be Matrix
for this step type.
stepmode
Specifies the runtime OS mode. May be either Bash
or PowerShell
. If not specified, defaults to Bash
.
configuration
Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinent tags:
Tag | Description of usage | Required/Optional |
---|---|---|
| May specify a PreMatrix preamble step. | Optional |
In addition, these tags can be defined to support the step's native operation:
Tag | Description of usage | Required/Optional |
---|---|---|
| When For more information, see Multi-node Matrix. NoteWhen both | Optional |
| Define the number of steplets that can concurrently run on a node. This helps in optimizing resource usage and ensures that the node efficiently handles steplets without being overwhelmed. NoteWhen both | Optional |
stepletMultipliers
In addition, these tags can be defined to support the step's native operation:
Tag | Description of usage | Required/Optional |
---|---|---|
| A collection of node pool names. Recognized only when If not defined, the step will be executed in the default node pool, or the node pool specified in the Example steps: - name: step_1 type: Matrix stepMode: Bash configuration: multiNode: true stepletMultipliers: environmentVariables: - foo: foo - bar: bar nodePools: - gcp - aws | Optional |
| A collection of sets of environment variable definitions. Each set of definitions will be used in an execution of a steplet in each of the defined If not defined, then a single steplet will execute for each of the defined | Optional |
| A collection of runtime definitions. The step will be executed in each defined runtime, on each of the specified If not defined, then each steplet will be executed in the default runtime, or the runtime specified in the | Optional |
| When set to Default is false. | Optional |
| A collection that specifies the combinations of | Optional |
| A collection that specifies the combinations of | Optional |
execution
Declares collections of shell command sequences to perform for pre- and post-execution phases:
Tag | Description of usage | Required/Optional |
---|---|---|
| Commands to execute in advance of | Optional |
| Main commands to execute for the step | Optional |
| Commands to execute on successful completion | Optional |
| Commands to execute on failed completion | Optional |
| Commands to execute on any completion | Optional |
Caution
onExecute
, onStart
, onSuccess
, onFailure
, and onComplete
are reserved keywords. Using these keywords in any other context in your execution scripts can cause unexpected behavior.