Repository navigation
Make it clearer that "automerge" exists and is preferred #518
Description
And provide better instructions about how to merge manually.
One thing that people don't realize is that the second PR number (in backport pull request) is autogenerated by GitHub, and had to be removed manually by hand before we click "Squash and Merge" button.
If we don't want to have to remember to remove that manually, then utilize the automerge feature.
As a reminder, automerge will be triggered if:
- In case of miss-islington's own PR, if the PR was approved by a core dev (has
awaiting mergelabel), tests all passing, CLA signed, and nodo-not-mergelabel. - In case it is not miss-islington's own PR: same as the above, with addition of
automergelabel
Activity
maxking commentedon Aug 11, 2019
I wonder if the right place for this content is https://devguide.python.org/committing/ or if there is a need for a dedicated page which helps core devs understand the features of the bots?
There already is #520 to make the above page simpler, but I feel more text on that page will just be invisible. But perhaps when it is re-written to be a more of a step-by-step guide, it can delegate to specific sections of this new page dedicated to bots when pointing out the workflow.
terryjreedy commentedon Aug 9, 2022
Automerge is great for backports, but is is wretched for original merges as the default title and message are usually wrong. Edits to title are ignored. I am not sure about messages, but is is wrong if the original PR had multiple commits and if there are trivial edits to the patch or multiple edits by one person.
erlend-aasland commentedon Aug 9, 2022
This is not quite correct. There are two scenarios to consider, and they are confusingly handled very differently by GitHub:
For PRs with multiple commits, you can edit the PR description (the "OP" of the PR) and the PR title before you apply the
automergelabel. It works well.See also the GitHub Docs regarding this behaviour.
ezio-melotti commentedon Aug 11, 2022
For backports I generally leave an "approve" review (after double-checking that the backport is indeed correct), and that is sufficient to trigger auto merging (at least for backports created by
miss-islington).There is also this setting:
erlend-aasland commentedon Aug 11, 2022
Ditto. By the way, do we mention the decisions GitHub takes when producing the squashed commit in the devguide? If not, we should; a lot of devs are surprised by this behaviour. It created a lot of headaches for me before I found out, at least.