Custom 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 and methods while using the Groovy Editor.

Set milliseconds value in SCRIPT_CHECK_INTERVAL_MILLIS variable to control re-execution of script, otherwise re-execution on not completed script happens at 5 minute interval by default.

The script must return true if the step is applicable, or false otherwise.  If no script is provided, the default is to return true (applicable).

On Error

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 optionally overridden for each release. Optionally, use a Groovy expression to make this field dynamic based on some contextual value (e.g. a property defined on the pipeline, and specified on the release).

When using a role script you can dynamically return a key/value pair. For example return [type: 'groupName', value: 'FD Administrators']. Supported types are roleId, roleName, groupId, and groupName. You can return Map with single key/value pair or list of such single key/value maps.