Pre-deploy Step

Name

The name of the step.

Description

An optional description for the step.

Project

The name of the project in the snapshot to run the Pre-deploy workflow.  This project must be in the snapshot, or the deployment will fail.

Package

Only applicable if partial deployment project is selected. If package name is provided that package will execute pre-deploy, if package name is left blank then All Files will go through pre-deploy.

If specific project/package combination is not part of release then this step will fail.

Force

Whether or not to force deploy the project.  If true, this is equivalent to checking force deploy when individually deploying a project to an environment through the deploy request form.  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).

Checking this will cause the Pre-deploy workflow to run even if the same project (package for partial deploy) version is already deployed to this stage (environment).

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.

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 Role

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.