View as Markdown

Dismiss Reviews

Dismiss previous reviews on a pull request.

The dismiss_reviews action allows Mergify to automatically dismiss approving reviews, reviews requesting changes, or both.

Parameters

Section titled Parameters
approved#list of string, boolean or from_requested_reviewers·defaulttrue

If set to true, all the approving reviews will be removed when the pull request is updated. If set to false, nothing will be done. If set to a list, each item should be the GitHub login of a user whose review will be removed. If set to from_requested_reviewers, the list of requested reviewers will be used to get whose review will be removed.

changes_requested#list of string, boolean or from_requested_reviewers·defaulttrue

If set to true, all the reviews requesting changes will be removed when the pull request is updated. If set to false, nothing will be done. If set to a list, each item should be the GitHub login of a user whose review will be removed. If set to from_requested_reviewers, the list of requested reviewers will be used to get whose review will be removed.

message#string or null·defaultnull

Message to use when dismissing reviews.

when#synchronize or always·defaultsynchronize

If set to synchronize, the action will run only if the pull request commits changed. Otherwise, it will run each time the rule matches.

when decides what counts as a trigger. With the default synchronize, the action only dismisses when someone pushes new commits, and it dismisses only the reviews submitted before that push. A push Mergify itself made, such as an update or a rebase, is not a trigger and leaves every review in place. Set when to always to dismiss every time the rule’s conditions match, whether or not the commits changed.

Examples

Section titled Examples

Dismiss Approvals When New Commits Are Pushed

Section titled Dismiss Approvals When New Commits Are Pushed

Keep approvals fresh by removing them whenever new commits are pushed, while leaving change requests in place.

pull_request_rules:
  - name: dismiss stale approvals
    conditions:
      - base = main
    actions:
      dismiss_reviews:
        approved: true
        changes_requested: false

Was this page helpful?

Edit this page on GitHub