Page Comparison

Name

The name of the step.

Description

An optional description for the step.

Includ Include Groups

Identifies which project group(s) from the snapshot to deploy.  The project groups are defined by the pipeline, and tagged on the projects/packages in the release.  If no groups are specified, all projects/packages from the snapshot will be included.

Exclude Groups

Skip deploying any projects/packages from the snapshot which are tagged in the release with the selected project groups(s).  Available project groups are defined by the pipeline.

Force Deploy

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 to next step.

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.