Deploy Step
- Erick Jones
- Jay-Ar Brouillard
- Ben Hoffman
The Deploy step deploys a single named project from the snapshot to the stage.
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 deploy. 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 be deployed, if package name is left blank then All Files will be deployed. 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). |
FlexFields | If Deploy Request FlexFields are configured, entry will be prompted for on the step configuration (not shown above). If the information is provided in the stage execution info, it will override the data entered on the step configuration. |
Inputs | If the deploy workflow for the project has inputs, entry will be prompted for on the step configuration (not shown above). If the information is provided in the stage execution info, it will override the data entered on the step configuration. |
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). |
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 optional overridden for each release. |
Deploying a named project reduces the generic nature of pipelines, as it assumes that the specific project is in the release and snapshot. To make the pipeline more generic, and therefore reusable, you should try to avoid tying it to specific projects where possible.
Script Variables
Related content
- style