Dismiss Reviews
Dismiss previous reviews on a pull request.
The dismiss_reviews
action allows Mergify to automatically dismiss approved
or changes requested reviews when new commits are pushed to the pull request.
The dismiss_reviews
action is a powerful tool that can help maintain the
freshness and relevance of reviews in your pull request workflow.
Parameters
Key name | Value type | Default | |
---|---|---|---|
approved | boolean, from_requested_reviewers or list of GitHub login | true
| |
If set to | |||
changes_requested | boolean, from_requested_reviewers or list of GitHub login | true
| |
If set to | |||
message | template | Pull request has been modified.
| |
The message to post when dismissing the review. | |||
when | synchronize or always | synchronize
| |
If set to |
Examples
Re-Review
pull_request_rules:- name: dismiss reviews when new commits are pushed, if the label "re-review" is presentconditions:- base=master- label=re-reviewactions:dismiss_reviews:
In this example, Mergify will automatically dismiss any reviews when new
commits are pushed to a pull request targeting the master
branch, but only if
the pull request has been labeled with "re-review".
Team-based Dismiss
You could also only dismiss the outdated reviews if the author is not a member of a particular team. This allows to keep the approval if the author is trusted, even if they update their code:
pull_request_rules:- name: remove outdated reviews for non trusted authorsconditions:- base=main- author!=@mytrustedteamactions:dismiss_reviews: