Overview
One of the upcoming changes to Pipelines is the ability to queue PRs for promotion, even when another promotion is already in progress. This means users no longer have to wait for the current promotion to complete before actioning their PRs.
How It Works
Promoting a PR
To kick off a promotion, a user selects their PR and clicks Promote changes
:
The PR will move to the Promoting section under Now:
If other users wish to promote their PRs while a promotion is already in progress, they can still do so by clicking Promote changes
. Their PRs will be added to a queue in a first-in, first-out (FIFO) order under Next:
Once the first PR has been promoted, the next PR will automatically be promoted. This carries on until the queue is empty.
If multiple PRs are selected for promotion together, they will be shown as a single unit in the queue:
Users can expand the unit to view all included PRs by clicking the v
arrow:
Managing the Queue
There are a few ways to manage the queue, with some actions available to all team members and others restricted to team owners.
Canceling a Promotion
Any user can remove a PR from the queue as long as the promotion has not started. This can be done by clicking the three ellipses to the right of the PR and selecting Cancel promotion
:
Reordering the Queue
Team owners can reorder the queue in two ways:
Clicking the three ellipses and selecting
Promote next
, which moves the PR to the top of the queue.Moving the PR to any position using the drag handle to the left of the PR name.
Staying Informed
If your team uses Slack or Microsoft Teams and wishes to be notified about validations, deployments and/or merge conflicts related to your PR(s), we strongly recommend setting up pipeline notifications. You are able to configure notifications based on events you care about, such as validation errors and merge conflicts.
Frequently Asked Questions
When can my PR be added to the queue?
The PR must meet all necessary prerequisites set by your team, such as pre-deployment steps, required reviews and merge conflict resolution.
What happens if my PR cannot be promoted?
If a PR encounters an issue during promotion, it will be removed from the queue and returned to the Open section. We recommend enabling pipeline notifications (Slack or Microsoft Teams) to stay informed when this happens.
What if I merge my PR through my version control system (VCS)?
If a PR is merged directly through your VCS, the next CI job run will pick up the changes, as it does today. However, we strongly recommend promoting PRs within Gearset to ensure the queueing order is followed.
What should I do if I need to commit additional changes to a PR that is already in the queue?
We strongly recommend removing the PR from the queue before making changes to ensure they are correctly reflected. Once you have removed it, you can follow the guidance in this document. If the PR is edited while still in the queue, the changes will be picked up as long as the PR has not reached the top of the queue. However, removing it first is the safest approach.
How does this work for long-term projects and releases?
Long-term projects and releases result in a single PR, which will behave like any other PR within the queue.