This page describes the behaviour of the DevSensei app Ship/Show/Ask feature in details. Refer to About Ship/Show/Ask PR workflow for description and motivation of Ship/Show/Ask.
(The content of this page only apply to applies if you enabled full Ship/Show/Ask support on your project or repository. Please refer to the Getting started - DC page to enable it.)
...
When an [Ask>=n] pull request is initiated, it will not be merged automatically. Moreover, a merge check requiring n (>=1) approvals is added to the pull request. This means that in order for the pull request to be successfully merged, it must receive n approvals from designated reviewers or team members.
This type of pull request is useful when changes to the codebase have the potential to have a significant impact or when there is a high level of uncertainty surrounding a particular change. By requiring multiple approvals, the risk of introducing bugs or breaking changes is reduced and the overall quality of the codebase is maintained.
To initiate an [Ask>=n] pull request, the user must select Manual merge and ask to require a certain number of approvals via the dedicated dropdown.
...
[Show>=n] pull requests will be automatically merged as soon as they receive n approvals. In addition, all other merge checks (such as passing tests, no open tasks, etc.) must be fulfilled for the pull request to be merged. This feature is useful for ensuring that a certain level of quality and review is met before code is merged into the main branch.
[Show] pull requests, on the other hand, will not require any approvals before they can be automatically merged. This feature is useful for small changes that do not require a thorough review. However, all other merge checks must still be fulfilled before the pull request can be merged.
...
a [Show] pull request doesn’t require any approvals to be merged. However, if Code Owners requires approvals for that same pull request, they will not be skipped. Therefore the pull request will not be automatically merged before Code Owners merge checks are fullfilled
a [Show>=2] pull request will require two approvals, regardless of who they are coming from. If for its part, Code Owners requires 3 approvals as merge check, then in total only 3 approvals will be necessary. The same applies for [Ask>=2], the difference being that Ask does not auto-merge
a [Ship] pull request will skip assignment of Code Owners. This is inline with the philosophy of Ship/Show/Ask: Ship pull request are meant for tiny and trivial changes to your repository. Such changes will be more effective if you don’t bother other team members to carry them through.
I accidentally create a pull request in the wrong category, can I do something about it?
...
DevSensei will check that a pull request can be auto-merged everytime an impactful change happens to the pull request. For example, a new task compleated, a new approval, a finished built or a change in the title. However, it will never do so less than 20 seconds after the creation of the pull request, leaving you a time window to change the pull request title (or delete the pull request) if you accidentally used the wrong one (see “I accidentally create a pull request in the wrong category, can I do something about it?”).
...
after creating the pull request, create an open task to prevent the merge (note that if that is the only merge check on your repository, you only have 20 seconds to do so (– see “When does DevSensei check if a pull request must be auto-merged?”)
you can create the pull request selecting “Manual merge”, and change the title to [SHOW>=n] (with n replaced with the desired number) when it is not longer work in progress.
I want to use Ship/Show/Ask but I don’t want Ship to skip Code Owners
This is something that is currently not supported. If you would be interested in such a feature, check out our support page, we will be happy to hear from you!