Edit

Edit pull request attributes.

The edit action allows Mergify to edit the body of a pull request. This can be helpful in situations where you want to automatically edit attributes of the pull request.

Parameters

Section titled Parameters
Key nameValue type
draftboolean

If the pull request should be a draft (true) or the other way around (false).

Examples

Section titled Examples

Converting a Pull Request to a Draft on Check Failure

Section titled Converting a Pull Request to a Draft on Check Failure

If any of your continuous integration checks fail, it might be worth converting the pull request to a draft automatically since it’s likely that it’s not ready for review.

pull_request_rules:
  - name: convert to draft
    conditions:
      - "#check-failure>0"
    actions:
      edit:
        draft: true