Feature Request: Expand "edit" action to include PR body editing

[leseb]

Hello Mergify Team,

I hope you're doing well!

I wanted to suggest a new feature for the edit action. It would be incredibly useful if we could use this action to edit the pull request body directly.

For example, something like this:

- name: Add reviewers to PR description
  conditions:
    - "#approved-reviews-by>=1"
  actions:
    comment:
      message: |
        This pull request has been reviewed by: {{approved_reviews_by|join(', ')}}
    edit:
      body: |
        {{ pull_request.body }}

        ---
        Reviewed-by: {{approved_reviews_by|join(', ')}}

This would make it easier to automatically update PR descriptions with relevant information like who has approved the review before merging the PR. This information will be added to the merge commit if GitHub is set up this way.

Thanks for considering this enhancement, and keep up the great work!

[jd]

Hi @leseb

That looks like a good idea, but I don't think it'd work as you expect. For example what would happen if leseb approve the PR?

Then the body becomes:

This is the body of the PR

---
Reviewed-by: leseb

Great! Now let's say your approval is removed and jd comes in approve. Now the body will be edited and changed to:

This is the body of the PR

---
Reviewed-by: leseb

---
Reviewed-by: jd

Not sure that's what you'd expect.

[leseb]

Sorry for the lack of details! I realize now that I should have included a merge statement in my rule. I'm trying to find a workaround for GitHub’s current limitation with customizing the merge message, as it only allows using the PR title or the title and body together. My goal is to include the names of everyone who approved the PR in the merge message before it gets merged.

Thanks!

[jd]

The best way to do this would be to let Mergify merge using a commit_message_template with the merge action https://docs.mergify.com/workflow/actions/merge/
You can then block the merge button using GitHub ruleset and only allowing Mergify to merge. You can use a label as a merge condition to trigger the merge from Mergify.

[leseb]

This is exactly what I needed, somehow I was under the impression that commit_message_template wasn't working at the merge commit level. Sorry for the noise and thanks for the quick reply!

I'm really not sure whether the initial proposal makes sense, for some other use case it might.