From fb28913d5cf3c17277f02fc9dc585efb51843d76 Mon Sep 17 00:00:00 2001 From: Henry Mercer Date: Fri, 16 Sep 2022 14:44:21 +0100 Subject: [PATCH] Add advice to the backport PR on how to run the checks quicker --- .github/update-release-branch.py | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/.github/update-release-branch.py b/.github/update-release-branch.py index d7c5101a2..9d20e38eb 100644 --- a/.github/update-release-branch.py +++ b/.github/update-release-branch.py @@ -86,21 +86,29 @@ def open_pr( body.append(f'- {commit.sha} - {get_truncated_commit_message(commit)}{author_description}') body.append('') - body.append('Please review the following:') + body.append('Please do the following:') if len(conflicted_files) > 0: - body.append(' - [ ] The `package.json` file contains the correct version.') - body.append(' - [ ] You have added commits to this branch that resolve the merge conflicts ' + + body.append(' - [ ] Ensure `package.json` file contains the correct version.') + body.append(' - [ ] Add commits to this branch to resolve the merge conflicts ' + 'in the following files:') body.extend([f' - [ ] `{file}`' for file in conflicted_files]) - body.append(' - [ ] Another maintainer has reviewed the additional commits you added to this ' + + body.append(' - [ ] Ensure another maintainer has reviewed the additional commits you added to this ' + 'branch to resolve the merge conflicts.') - body.append(' - [ ] The CHANGELOG displays the correct version and date.') - body.append(' - [ ] The CHANGELOG includes all relevant, user-facing changes since the last release.') - body.append(' - [ ] There are no unexpected commits being merged into the ' + target_branch + ' branch.') - body.append(' - [ ] The docs team is aware of any documentation changes that need to be released.') + body.append(' - [ ] Ensure the CHANGELOG displays the correct version and date.') + body.append(' - [ ] Ensure the CHANGELOG includes all relevant, user-facing changes since the last release.') + body.append(' - [ ] Check that there are not any unexpected commits being merged into the ' + target_branch + ' branch.') + body.append(' - [ ] Ensure the docs team is aware of any documentation changes that need to be released.') + + if not is_v2_release: + body.append(' - [ ] Remove and re-add the "Update dependencies" label to the PR to trigger just this workflow.') + 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.') + if is_v2_release: - body.append(' - [ ] The mergeback PR is merged back into ' + source_branch + ' after this PR is merged.') - body.append(' - [ ] The v1 release PR is merged after this PR is merged.') + body.append(' - [ ] Merge the mergeback PR that will automatically be created once this PR is merged.') + body.append(' - [ ] Merge the v1 release PR that will automatically be created once this PR is merged.') title = 'Merge ' + source_branch + ' into ' + target_branch