Clarify merging with merge commit (#1291 )

* Clarify merging with merge commit * Add merge commit message to mergeback PRs
2025-12-07 00:08:06 +08:00 · 2022-10-07 19:05:42 +00:00
2 changed files with 2 additions and 2 deletions
--- a/.github/update-release-branch.py
+++ b/.github/update-release-branch.py
@@ -104,7 +104,7 @@ def open_pr(
    body.append(' - [ ] Wait for the "Update dependencies" workflow to push a commit updating the dependencies.')
    body.append(' - [ ] Mark the PR as ready for review to trigger the full set of PR checks.')

-  body.append(' - [ ] Approve and merge this PR.')
+  body.append(' - [ ] Approve and merge this PR. Make sure `Create a merge commit` is selected rather than `Squash and merge` or `Rebase and merge`.')

  if is_v2_release:
    body.append(' - [ ] Merge the mergeback PR that will automatically be created once this PR is merged.')
--- a/.github/workflows/post-release-mergeback.yml
+++ b/.github/workflows/post-release-mergeback.yml
@@ -122,7 +122,7 @@ jobs:
            - [ ] Remove and re-add the "Update dependencies" label to the PR to trigger just this workflow.
            - [ ] Wait for the "Update dependencies" workflow to push a commit updating the dependencies.
            - [ ] Mark the PR as ready for review to trigger the full set of PR checks.
-            - [ ] Approve and merge the PR.
+            - [ ] Approve and merge the PR. Make sure `Create a merge commit` is selected rather than `Squash and merge` or `Rebase and merge`.
          EOF
          )