Versions Compared

Key

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

The Pre-deploy All step runs the pre-deploys deploy workflows for all project versions (or packages) in the snapshot, which means if there are multiple projects . Each project configured in release , only those projects with a Pre-deploy wokrflow workflow configured will be executed in this step. Snapshot is created based on projects included in release. This is very important step to make pipeline reusable across releases. Pre-deploy will run the pre-deploy workflows for all the projects in parallel, the priority set for the release projects will not be used in Pre-deploy All step. You can additionally use project groups with more than one Pre-deploy All step to control sequencing of pre-deploy executions. For example, Pre-deploy DB changes, Pre-deploy All applications etc.

Additionally, project the Pre-deploy workflow is only executed for projects (or packages) are only deployed if the version is not already deployed to the stage (environment) unless Force Deploy is checked. It is recommended to not check Force DeployChecking Force Deploy will cause the Pre-deploy workflows to run whether the deployment was completed or not.

Field

Description

Step Name

The name of the step.

Description

An optional description for the step.

Project Groups

Identifies which group or groups 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 Project GroupsSkip deploying any projects/packages from the snapshot which are tagged in the release with the selected project group(s).  Available project groups are defined by the pipeline.
Force DeployWhether or not to force deploy the projects.  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).
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 to next step.
Notify Pipeline RolesSelects 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.

...

Tip

The Pre-deploy All step uses allows the output from workflow and will set the values to the Pre-deploy workflows to flow into the Deploy workflow input for each project. For this to work, workflow developers has to must use the same name and data type for both the Pre-deploy output(with "Return As Outout Output" selected) and Deploy input variables in the respective workflowworkflows.

Script Variables

Include Page
Pipeline Groovy Variables and Methods
Pipeline Groovy Variables and Methods