Skip to content

Commit fb28913

Browse files
committed
Add advice to the backport PR on how to run the checks quicker
1 parent 4f10467 commit fb28913

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

.github/update-release-branch.py

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,21 +86,29 @@ def open_pr(
8686
body.append(f'- {commit.sha} - {get_truncated_commit_message(commit)}{author_description}')
8787

8888
body.append('')
89-
body.append('Please review the following:')
89+
body.append('Please do the following:')
9090
if len(conflicted_files) > 0:
91-
body.append(' - [ ] The `package.json` file contains the correct version.')
92-
body.append(' - [ ] You have added commits to this branch that resolve the merge conflicts ' +
91+
body.append(' - [ ] Ensure `package.json` file contains the correct version.')
92+
body.append(' - [ ] Add commits to this branch to resolve the merge conflicts ' +
9393
'in the following files:')
9494
body.extend([f' - [ ] `{file}`' for file in conflicted_files])
95-
body.append(' - [ ] Another maintainer has reviewed the additional commits you added to this ' +
95+
body.append(' - [ ] Ensure another maintainer has reviewed the additional commits you added to this ' +
9696
'branch to resolve the merge conflicts.')
97-
body.append(' - [ ] The CHANGELOG displays the correct version and date.')
98-
body.append(' - [ ] The CHANGELOG includes all relevant, user-facing changes since the last release.')
99-
body.append(' - [ ] There are no unexpected commits being merged into the ' + target_branch + ' branch.')
100-
body.append(' - [ ] The docs team is aware of any documentation changes that need to be released.')
97+
body.append(' - [ ] Ensure the CHANGELOG displays the correct version and date.')
98+
body.append(' - [ ] Ensure the CHANGELOG includes all relevant, user-facing changes since the last release.')
99+
body.append(' - [ ] Check that there are not any unexpected commits being merged into the ' + target_branch + ' branch.')
100+
body.append(' - [ ] Ensure the docs team is aware of any documentation changes that need to be released.')
101+
102+
if not is_v2_release:
103+
body.append(' - [ ] Remove and re-add the "Update dependencies" label to the PR to trigger just this workflow.')
104+
body.append(' - [ ] Wait for the "Update dependencies" workflow to push a commit updating the dependencies.')
105+
body.append(' - [ ] Mark the PR as ready for review to trigger the full set of PR checks.')
106+
107+
body.append(' - [ ] Approve and merge this PR.')
108+
101109
if is_v2_release:
102-
body.append(' - [ ] The mergeback PR is merged back into ' + source_branch + ' after this PR is merged.')
103-
body.append(' - [ ] The v1 release PR is merged after this PR is merged.')
110+
body.append(' - [ ] Merge the mergeback PR that will automatically be created once this PR is merged.')
111+
body.append(' - [ ] Merge the v1 release PR that will automatically be created once this PR is merged.')
104112

105113
title = 'Merge ' + source_branch + ' into ' + target_branch
106114

0 commit comments

Comments
 (0)