Skip to main content

Deployment steps for releases, LTP, sandbox updates, and integrations

Learn how deployment steps behave across releases, Long-term Projects, developer sandbox updates, and VCS and ticketing integrations.

Written by Jacob Joshua

This article explains how existing pre- and post-deployment steps behave as work moves through releases, Long-term Projects, back propagation, developer sandbox updates, and connected tools.

To learn how to create and manage deployment steps on a pull request, see Pre and Post Deployment Steps in Gearset Pipelines.

Releases

When a pull request (PR) is included in a release, its deployment steps are automatically added to the release.

These steps will appear in the release sidebar, organized by feature. You can edit them just like you would for an individual PR, and you can also add deployment steps directly to the release.

If any pre-deployment steps are incomplete, the release cannot be deployed until they are all finished.

After deployment, post-deployment steps for each PR will appear separately in the Pending completion tab.

Scheduled releases

You can schedule a release with incomplete pre-deployment steps. However, all pre-deployment steps must be completed before the scheduled deployment time. Otherwise, Gearset won’t deploy the release.

Gearset displays the following reminder when you schedule the release:​
"You still have [number] pre-deployment step(s) to finish. If they're not marked completed before the scheduled release time, the release won't happen."

Screenshot 2024-10-04 at 09 47 10

Long-term Projects

Similarly to Feature and Release Pull Requests, you can attach pre and post-deployment steps to a Long-term Project Pull Request when integrating the project work back into your main pipeline.

At the point of creating the PR, you can navigate to the Deployment Steps tab, adding your steps there. Alternatively, deployment steps can be added to an existing Long-term Project PR when it is selected on the pipeline screen.

A Long-term Project pull request can’t be promoted until all its pre-deployment steps are complete. After a successful promotion, any incomplete post-deployment steps appear in the environment’s Pending completion tab.

Back propagation and developer sandbox updates

Pre- and post-deployment steps will also show up on back propagation PRs, with post-deployment steps showing up in the Pending completion tab.

Developer sandbox updates

Deployment steps also appear when you update a developer sandbox with the latest changes from the base branch.

This works slightly differently from how the steps appear on a PR, as you just need to check a single 'Mark all steps as complete' checkbox in order to proceed.

Similarly, the post-deployment steps will be shown in a 'Pending completion' tab and again, you can select many PRs and mark their post steps as complete in one go.

Which steps appear on a developer sandbox update?

Developer sandbox updates only include steps set to All environments. Steps targeted at specific environments, such as a step set to run against Production only, don't appear on developer sandbox updates. This applies to both pre-deployment steps and post-deployment steps in the Pending completion tab.

VCS and Ticketing Integration

When enabled in the pipeline preferences, Gearset can record a living comment against your pull requests and any linked Jira tickets. Whenever a deployment step changes, the comment is updated to reflect its current state.

Recording is controlled by two toggles under Edit pipeline > Deployment steps:

  • Record pre and post deployment steps on pull requests

  • Record pre and post deployment steps on associated Jira tickets

Both comments list every pre- and post-deployment step with its current status, along with the time and the team member for any steps already completed.

On the pull request:

The comment on a Jira ticket also includes a View deployment steps in Gearset link, so the steps can be reached without navigating back through the pipeline. Where the link points depends on the state of the PR:

  • Open PR: the pipeline view, where the steps can be viewed and completed.

  • Merged PR: the promotion history for that environment, filtered to the date range covering the promotion.

On the linked Jira ticket:

Note: Both comment titles include (do not edit). Gearset rewrites the comment whenever a step changes, so any manual edits will be overwritten.

FAQs

Can I undo a "Mark as completed" post-deployment step?

Once you've pressed Mark as complete on a promoted PR - there is no way to undo this change as at this point the PR is showing as read-only on the Promotion history tab for a given Pipeline environment.

But as long as you don't hit Mark as complete button, Gearset allows you to amend the statuses of any pending post-deployment steps.
​
You can do that by ticking them (completed) and unchecking steps via Mark as incomplete option, as shown below:

Did this answer your question?