Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Pre-deploy step executes the Pre-deploy workflow of a single named project from the snapshot to the stage. The project has to configure must have a configured Pre-deploy Workflow in the project configuration screen for the step to run.

...

Field

Description

Step Name

The name of the step.

Description

An optional description for the step.

Project Name

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 Name

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 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 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).

ContinueIf checked, any failure will be ignored, and the pipeline execution will continue.
Notify Pipeline RoleSelects 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.

...