What license do I need to use this feature?
The use of Pre/Post Deployment Steps in pipelines is tied to the Automation Starter, Teams, and Enterprise Add-on tiers
Overview
Gearset supports pre and post-deployment steps in Pipelines. This allows you to add manual and automatic steps to a PR when you create it or while the PR is in progress. When adding pre or post deployment steps to a PR, you can associate those steps with any environment where they are needed.
Pre-deployment steps must be marked as complete before the PR can be merged in the Pipelines UI. After the PR is merged, its post-deployment steps are highlighted for completion.
To create and manage reusable manual-step templates, see Deployment Steps Library in Gearset Pipelines.
Available deployment step types
When adding a deployment step, the available options depend on whether you are adding a pre or post-deployment step.
Step | Type | Available for | What it does |
Manual step
| Manual | Pre and post-deployment | Create a checklist item from scratch or from a saved template in your deployment step library. |
Activate Flows | Automatic | Post-deployment only | Activates deployed Flows in production orgs. |
Commit Agent Scripts | Automatic | Post-deployment only | Automatically commits deployed Agent Scripts in the target org. |
Activate Agents and Bots | Automatic | Post-deployment only | Automatically activates deployed Einstein Bots and committed Agent Scripts in the target org. |
Activate Data Kits | Automatic | Post-deployment only | Automatically activates deployed Data Kits in the target org. |
Adding pre/post deployment steps to your PR
Adding a manual step
You can add your deployment steps to your PR when creating it in the Pipelines UI or in any environment where the PR is awaiting promotion.
Add a name and optional Markdown-formatted description for the manual step, then choose whether it should run against all environments or only specific environments.
Note: Markdown can be used here to add formatting to your description with headers, lists, sections, or embed more "rich" content like links and code blocks.
If you're unfamiliar with Markdown, you can see our guide for useful tips here.
All the steps will then appear in the specified environments when the PR is created.
To add a step to an existing pull request, select the pull request in the pipeline and click Add step. Choose whether to add a pre or post-deployment step, then select a manual or automatic action.
Adding an automatic post-deployment step
Gearset disables any options that aren’t supported for the selected deployment stage. For example, automatic activation and commit steps run after deployment, so they are unavailable when adding a pre-deployment step.
To add an automatic action, select Add post-deployment step, then choose the action you want Gearset to run.
Choose whether it should run against all environments or only specific environments, then click Add step.
This will be shown in the list of Post-deployment steps for that PR as below.
After a successful deployment, Gearset runs the action against the target org. If the action completes successfully, Gearset marks the step as complete.
Managing your pre/post-deployment steps
Note: Parallel environments that point to the same branch will require the pre-deployment steps to be completed on both environments before promotion.
Your pre and post-deployment steps are now attached to the PR. You will only be able to promote the PR once the linked pre-deployment steps have been completed.
Gearset will also append the name of the team member who marked the steps as complete to each step.
After the PR is promoted, any incomplete post-deployment steps appear in the Pending completion tab for manual follow-up.
The pending post-deployment steps will remain open in this tab until they have been marked as complete. The Pending completion tab will only appear when there are pending post-deployment steps in that environment.
Gearset will also highlight any environment with incomplete post-deployment steps in the UI by displaying a notification: "Some post-deployment steps haven't been completed".
Completed pre-deployment steps and pending or completed post-deployment steps can also be found on the promotion history page for each environment.
Edit, undo or reorder a list of steps
You can undo a completed step, edit the steps, or reorder a list of steps in any environment where they are located. When editing the steps, you can edit the steps for all environments where they occur or for just the selected environment.
For more information about completing steps after promotion and how steps behave across releases and other Pipeline workflows, see Deployment steps for releases, sandbox updates, and integrations