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

Key name	Value type	Default
`draft`	boolean
If the pull request should be a draft (`true`) or the other way around (`false`).

Examples

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.

1
pull_request_rules:
2
  - name: convert to draft
3
    conditions:
4
      - "#check-failure>0"
5
    actions:
6
      edit:
7
        draft: true

Edit on GitHub