What license do I need to use this feature?
The use of Pre/Post Deployment Steps is tied to the Automation Starter, Teams, and Enterprise Add-on tiers.
Overview
Teams often have recurring tasks that need to be completed before or after a deployment, such as notifying stakeholders or running smoke tests.
Gearset’s pre- and post-deployment steps help you record these tasks and track their completion as a pull request moves through your pipeline.
The deployment step library lets you save commonly used manual steps as reusable templates. When adding a step to a pull request, you can select a saved template instead of recreating the instructions each time. You can also configure a template to be added automatically to new pull requests.
Creating your Deployment Steps library
You can create your library of deployment steps via the Edit pipeline modal, accessible from the cog icon next to the pipeline selection dropdown.
In the Edit pipeline modal, open the Deployment steps tab. Under Manage deployment step library, you can create reusable pre- and post-deployment step templates.
Click Add + and choose whether to create a pre- or post-deployment step. Enter a name and an optional Markdown-formatted description, then save the template.
Note: You can’t choose environments when creating a template. After adding the template to a pull request, you can choose whether the step runs against all environments or only specific environments.
When creating or editing a template in your deployment step library, select Auto-import onto pull requests if you want Gearset to add it automatically to new pull requests.
Managing your library
After creating your library for the first time, you can head back to the Edit pipeline modal to make changes to it, including adding to your library, deleting from it, and editing steps within the library.
Lastly, you can drag-and-drop items within the library to re-order them, perhaps ensuring that the most important or frequently required deployment steps within the library appear at the top.
Adding saved templates to a pull request
When adding a pre- or post-deployment step to a pull request, Gearset displays the available step types and saved templates.
To add a saved template:
Open the Deployment steps section of the pull request.
Select Add pre-deployment step or Add post-deployment step.
Choose a template from Saved templates.
Review the added step and make any required changes.
Choose whether the step should run against all environments or only specific environments.
Click Add step.
To learn more about Pre and Post Deployment Steps within Gearset Pipelines, you can head over to our documentation.