Deploy All Step
- Karl Henselin
- Chandresh Patel
- Vivek Vanka
The Deploy All step deploys all project versions (or packages) in the snapshot, which means that projects configured in release are deployed. Snapshot is created based on projects included in release. This is very important step to make pipeline reusable across releases. Deployment sequence is derived based on priority set on the release projects. You can additionally use project groups with more than one Deploy All step to control sequencing of deployments. For example, Deploy DB changes, Deploy all applications etc. Even though sequencing using priority, project groups or both is supported, it is much more easier to manage sequencing just using priority instead of using project groups.
Additionally, project (or packages) are only deployed if not already deployed to stage (environment) unless Force Deploy is checked. It is recommended to not check Force Deploy.
If Snapshot project or package is no longer part of Release, then it will skipped.
Field | Description |
|---|---|
Name | The name of the step. |
Description | An optional description for the step. |
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 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 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 |
The Deploy All step uses the priority for each project/package contained within the release. Â If a deployment fails, projects or packages with a higher priority will not be submitted, and the step will fail.
If the projects have FlexFields or Inputs defined, values must be provided on the stage execution info screen. Â If the values are required and not specified, the underlying workflow execution will fail.
Script Variables
- style