Custom Step
- Chandresh Patel
- Jay-Ar Brouillard
- Erick Jones
The Custom step executes provided Groovy script to determine status of step. This can be very useful to integrate additional tools in pipeline. You can write code to invoke external systems.
Pipeline will execute RUNNING step at regular interval, and step will be considered complete only when it returns SUCCESSFUL or FAILED.
Field | Description |
|---|---|
Step Name | The name of the step. |
Description | An optional description for the step. |
Groovy Script | Groovy script to provide implementation of Step. Return SUCCESSFUL, RUNNING or FAILED to indicate status of Step. This can be used to provide customized implementation in pipeline to interface with external system or do any other programmatic checks. If no status is returned SUCCESSFUL is implied by default. The script has access to variables and methods listed in Pipeline Groovy Variables and Methods. |
Precondition | An optional Groovy script which determines whether the gate or step is applicable during execution. The script has access to variables and methods listed in Pipeline Groovy Variables and Methods. You can find these variables methods using Variable Lookup help. The script must return true if the gate is applicable, or false otherwise. Â If no script is provided, the default is to return true (applicable). |
Continue | If checked, any failure will be ignored, and the pipeline execution will continue. |
Notify Pipeline Roles | Selects one or more roles from the pipeline definition to notify in case of error. Default role members are defined on the pipeline, and optional overridden for each release. |
Script Variables
- style