From 40b7c0703946fd4d6fee14649c42a2997fa5b658 Mon Sep 17 00:00:00 2001 From: Daniel Sotirhos Date: Wed, 17 May 2023 09:57:48 -0700 Subject: [PATCH] Fix: PR checklist should mention unchaining steps (#5190) --- .github/pull_request_template.md | 9 +++++- .github/pull_request_template.md.template.py | 30 +++++++++++++++++--- OPERATOR.rst | 7 ----- 3 files changed, 34 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f370221e56..5bc24d3f06 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -125,9 +125,16 @@ Uncheck the *before every review* checklists. Update the `N reviews` label. - [ ] Pushed merge commit to GitHub +### Operator (chains) + +- [ ] Changed the target branch of the blocked PR to `develop` or this PR is not labeled `base` +- [ ] Removed the `chained` label from the blocked PR or this PR is not labeled `base` +- [ ] Removed the blocking relationship from the blocked PR or this PR is not labeled `base` +- [ ] Removed the `base` label from this PR or this PR is not labeled `base` + + ### Operator (after pushing the merge commit) -- [ ] Shortened the PR chain or this PR is not labeled `base` - [ ] Pushed merge commit to GitLab `dev` or PR is labeled `no sandbox` - [ ] Pushed merge commit to GitLab `anvildev` or PR is labeled `no sandbox` - [ ] Build passes on GitLab `dev`1 diff --git a/.github/pull_request_template.md.template.py b/.github/pull_request_template.md.template.py index c6e6007d69..13f1e0a6bc 100644 --- a/.github/pull_request_template.md.template.py +++ b/.github/pull_request_template.md.template.py @@ -588,14 +588,36 @@ def main(): 'type': 'cli', 'content': 'Pushed merge commit to GitHub' }, + *iif(t in (T.default, T.gitlab), [ + { + 'type': 'h2', + 'content': 'Operator (chains)' + }, + { + 'type': 'cli', + 'content': 'Changed the target branch of the blocked PR to `develop`', + 'alt': 'or this PR is not labeled `base`' + }, + { + 'type': 'cli', + 'content': 'Removed the `chained` label from the blocked PR', + 'alt': 'or this PR is not labeled `base`' + }, + { + 'type': 'cli', + 'content': 'Removed the blocking relationship from the blocked PR', + 'alt': 'or this PR is not labeled `base`' + }, + { + 'type': 'cli', + 'content': 'Removed the `base` label from this PR', + 'alt': 'or this PR is not labeled `base`' + }, + ]), { 'type': 'h2', 'content': 'Operator (after pushing the merge commit)' }, - iif(t in (T.default, T.gitlab), { - 'type': 'cli', - 'content': 'Shortened the PR chain', 'alt': 'or this PR is not labeled `base`' - }), *[ { 'type': 'cli', diff --git a/OPERATOR.rst b/OPERATOR.rst index 212aa31f50..7b82d415ae 100644 --- a/OPERATOR.rst +++ b/OPERATOR.rst @@ -232,13 +232,6 @@ For an example of how to document failures within a PR `click here`_. .. _click here: https://github.com/DataBiosphere/azul/pull/3050#issuecomment-840033931 -Chain shortening -^^^^^^^^^^^^^^^^ - -Change the target branch of the blocked PR to ``develop`` and remove the ``chained`` -label from that PR. Remove the ``base`` label from the blocking PR. Lastly, remove the blocking -relationship. - Upgrading GitLab & ClamAV ^^^^^^^^^^^^^^^^^^^^^^^^^