From c6c7d293ca64d6a7e953b9680a26c5ffea86a392 Mon Sep 17 00:00:00 2001 From: Angela P Wen Date: Fri, 7 Oct 2022 12:05:42 -0700 Subject: [PATCH] Clarify merging with merge commit (#1291) * Clarify merging with merge commit * Add merge commit message to mergeback PRs --- .github/update-release-branch.py | 2 +- .github/workflows/post-release-mergeback.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/update-release-branch.py b/.github/update-release-branch.py index 9d20e38eb..b547b1736 100644 --- 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.') diff --git a/.github/workflows/post-release-mergeback.yml b/.github/workflows/post-release-mergeback.yml index 7b8b8a776..1ba81b2b2 100644 --- 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 )