Skip to content

Commit

Permalink
Track main AnVIL deployments in PR checklists (#4122)
Browse files Browse the repository at this point in the history
  • Loading branch information
hannes-ucsc authored and achave11-ucsc committed Sep 14, 2022
1 parent 279e653 commit 372be80
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 29 deletions.
20 changes: 13 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE/backport.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This is the PR template for backport PRs against `develop`.
### Author

- [ ] Target branch is `develop`
- [ ] Name of source branch matches `backports/<7-digit SHA1 of most recent backported commit>`
- [ ] Name of PR branch matches `backports/<7-digit SHA1 of most recent backported commit>`
- [ ] PR title contains the 7-digit SHA1 of the backported commits
- [ ] PR title references the issues relating to the backported commits
- [ ] PR title references the PRs that introduced the backported commits
Expand All @@ -21,7 +21,7 @@ This is the PR template for backport PRs against `develop`.
- [ ] Added `reqs` label to PR <sub>or this PR does not touch requirements*.txt</sub>


### Primary reviewer (after rejection)
### Primary reviewer (after requesting changes)

Uncheck the *Author (requirements)* and *Author (rebasing, integration test)*
checklists.
Expand All @@ -40,18 +40,24 @@ checklists.

- [ ] Sanity-checked history
- [ ] Pushed PR branch to GitHub
- [ ] Branch pushed to GitLab and added `sandbox` label <sub>or PR is labeled `no sandbox`</sub>
- [ ] Build passed in sandbox <sub>or PR is labeled `no sandbox`</sub>
- [ ] Pushed PR branch to GitLab `dev` and added `sandbox` label <sub>or PR is labeled `no sandbox`</sub>
- [ ] Build passes in `sandbox` deployment <sub>or PR is labeled `no sandbox`</sub>
- [ ] Pushed PR branch to GitLab `anvildev` <sub>or PR is labeled `no sandbox`</sub>
- [ ] Build passes in `anvilbox` deployment <sub>or PR is labeled `no sandbox`</sub>
- [ ] Added PR reference (this PR) to merge commit title
- [ ] Collected commit title tags in merge commit title
- [ ] Pushed merge commit to GitHub


### Operator (after pushing the merge commit)

- [ ] Pushed merge commit to GitLab <sub>or PR is labeled `no sandbox`</sub>
- [ ] Deleted PR branch from GitHub and GitLab
- [ ] Build passes on GitLab<sup>1</sup>
- [ ] Pushed merge commit to GitLab `dev` <sub>or PR is labeled `no sandbox`</sub>
- [ ] Pushed merge commit to GitLab `anvildev` <sub>or PR is labeled `no sandbox`</sub>
- [ ] Build passes on GitLab `dev`<sup>1</sup>
- [ ] Build passes on GitLab `anvildev`<sup>1</sup>
- [ ] Deleted PR branch from GitHub
- [ ] Deleted PR branch from GitLab `dev`
- [ ] Deleted PR branch from GitLab `anvildev`

<sup>1</sup> When pushing the merge commit is skipped due to the PR being
labelled `no sandbox`, the next build triggered by a PR whose merge commit *is*
Expand Down
6 changes: 4 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Connected issue: #4014
### Author

- [ ] Target branch is `develop`
- [ ] Name of source branch matches `gitlab/yyyy-mm-dd/<GitLab version>`
- [ ] Name of PR branch matches `gitlab/yyyy-mm-dd/<GitLab version>`
- [ ] PR title matches `Update GitLab to <GitLab version> (#4014)`
- [ ] Disconnected any other PRs currently connected to #4014 via ZenHub
- [ ] PR is connected to issue #4014 via ZenHub
Expand All @@ -20,12 +20,14 @@ Connected issue: #4014
### Author (deploy)

- [ ] Deployed changes to `dev.gitlab`
- [ ] Deployed changes to `anvildev.gitlab`
- [ ] Deployed changes to `prod.gitlab`


### Primary reviewer (after approval)

- [ ] Verified background migrations for `dev.gitlab` are complete
- [ ] Verified background migrations for `anvildev.gitlab` are complete
- [ ] Verified background migrations for `prod.gitlab` are complete
- [ ] Actually approved the PR
- [ ] Labeled connected issue as `no demo`
Expand All @@ -37,7 +39,7 @@ Connected issue: #4014

### Operator (before pushing merge the commit)

- [ ] Rebased and squashed branch
- [ ] Rebased and squashed PR branch
- [ ] Sanity-checked history
- [ ] Pushed PR branch to GitHub
- [ ] Added PR reference to merge commit title
Expand Down
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE/hotfix.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Connected issue: #0000
### Author
-
- [ ] Target branch is `prod`
- [ ] Name of source branch matches `hotfixes/<GitHub handle of author>/<issue#>-<slug>`
- [ ] Name of PR branch matches `hotfixes/<GitHub handle of author>/<issue#>-<slug>`
- [ ] PR title references the connected issue
- [ ] PR title is `Hotfix: ` followed by title of connected issue
- [ ] PR is connected to issue via Zenhub
Expand All @@ -35,7 +35,7 @@ Connected issue: #0000

### Author (before every review)

- [ ] Rebased branch on `prod`, squashed old fixups
- [ ] Rebased PR branch on `prod`, squashed old fixups


### Primary reviewer (after approval)
Expand All @@ -49,7 +49,7 @@ Connected issue: #0000

### Operator (before pushing merge the commit)

- [ ] Rebased and squashed branch onto `prod`
- [ ] Rebased and squashed PR branch onto `prod`
- [ ] Sanity-checked history
- [ ] Pushed PR branch to GitHub
- [ ] Added PR reference to merge commit title
Expand All @@ -61,7 +61,7 @@ Connected issue: #0000
### Operator (after pushing the merge commit)

- [ ] Pushed merge commit to GitLab `prod`
- [ ] Deleted PR branch from GitHub and GitLab
- [ ] Deleted PR branch from GitHub and GitLab `prod`
- [ ] Build passes on GitLab


Expand Down
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE/promotion.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Connected issue: #0000
### Author

- [ ] Target branch is `prod`
- [ ] Source branch matches `promotions/yyyy-mm-dd`
- [ ] Name of PR branch matches `promotions/yyyy-mm-dd`
- [ ] Title of connected issue matches `Promotion yyyy-mm-dd`
- [ ] PR title starts with title of connected issue
- [ ] PR title references the connected issue
- [ ] PR title starts with title of connected issue
- [ ] PR is connected to issue via Zenhub
- [ ] PR description links to connected issue

Expand All @@ -31,7 +31,7 @@ Connected issue: #0000
### Primary reviewer (after approval)

- [ ] Actually approved the PR
- [ ] Labeled PR as `no sandbox`
- [ ] Labeled PR `no sandbox`
- [ ] Moved ticket to *Approved* column
- [ ] Assigned PR to current operator

Expand Down Expand Up @@ -61,7 +61,7 @@ Connected issue: #0000
- [ ] Deleted unreferenced indices in `prod` <sub>or this PR does not remove catalogs or otherwise causes unreferenced indices</sub>
- [ ] Started reindex in `prod` <sub>or this PR does not require reindexing</sub>
- [ ] Checked for and triaged indexing failures <sub>or this PR does not require reindexing</sub>
- [ ] Emptied fail queues in target deployment <sub>or this PR does not require reindexing</sub>
- [ ] Emptied fail queues in `prod` deployment <sub>or this PR does not require reindexing</sub>


### Operator
Expand Down
37 changes: 25 additions & 12 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Connected issue: #0000
### Author

- [ ] Target branch is `develop`
- [ ] Name of source branch matches `issues/<GitHub handle of author>/<issue#>-<slug>`
- [ ] Name of PR branch matches `issues/<GitHub handle of author>/<issue#>-<slug>`
- [ ] PR title references the connected issue
- [ ] PR title matches<sup>1</sup> title of connected issue <sub>or comment in PR explains why they're different</sub>
- [ ] Title of at least one commit references connected issue
- [ ] PR is connected to issue via Zenhub
- [ ] PR description links to connected issue
- [ ] Added `partial` label to PR <sub>or this PR completely resolves the connected issue</sub>
- [ ] Added `partial` label to PR <sub>or this PR completely resolves the connected issue</sub>

<sup>1</sup> when the issue title describes a problem, the PR title is `Fix: ` followed by the issue title

Expand Down Expand Up @@ -56,7 +56,7 @@ Connected issue: #0000
- [ ] Reverted the temporary hotfix connected to the issue <sub>or there is no temporary hotfix for the connected issue on the `prod` branch</sub>


### Author (requirements)
### Author (requirements, before every review)

- [ ] Ran `make requirements_update` <sub>or this PR does not touch requirements*.txt, common.mk, Makefile and Dockerfile</sub>
- [ ] Added `R` tag to commit title <sub>or this PR does not touch requirements*.txt</sub>
Expand All @@ -66,7 +66,7 @@ Connected issue: #0000
### Author (rebasing, integration test)

- [ ] `make integration_test` passes in personal deployment <sub>or this PR does not touch functionality that could break the IT</sub>
- [ ] Rebased branch on `develop`, squashed old fixups
- [ ] Rebased PR branch on `develop`, squashed old fixups


### Peer reviewer (after requesting changes)
Expand Down Expand Up @@ -104,14 +104,19 @@ checklists. Update the `N reviews` label.

- [ ] Checked `reindex` label and `r` commit title tag
- [ ] Checked that demo expectations are clear <sub>or connected issue is labeled as `no demo`</sub>
- [ ] Rebased and squashed branch
- [ ] Rebased and squashed PR branch
- [ ] Sanity-checked history
- [ ] Pushed PR branch to GitHub
- [ ] Branch pushed to GitLab and added `sandbox` label <sub>or PR is labeled `no sandbox`</sub>
- [ ] Build passed in sandbox <sub>or PR is labeled `no sandbox`</sub>
- [ ] Pushed PR branch to GitLab `dev` and added `sandbox` label <sub>or PR is labeled `no sandbox`</sub>
- [ ] Build passes in `sandbox` deployment <sub>or PR is labeled `no sandbox`</sub>
- [ ] Deleted unreferenced indices in `sandbox` <sub>or this PR does not remove catalogs or otherwise causes unreferenced indices</sub>
- [ ] Started reindex in `sandbox` <sub>or this PR does not require reindexing `sandbox`</sub>
- [ ] Checked for failures in `sandbox` <sub>or this PR does not require reindexing `sandbox`</sub>
- [ ] Pushed PR branch to GitLab `anvildev` <sub>or PR is labeled `no sandbox`</sub>
- [ ] Build passes in `anvilbox` deployment <sub>or PR is labeled `no sandbox`</sub>
- [ ] Deleted unreferenced indices in `anvilbox` <sub>or this PR does not remove catalogs or otherwise causes unreferenced indices</sub>
- [ ] Started reindex in `anvilbox` <sub>or this PR does not require reindexing `sandbox`</sub>
- [ ] Checked for failures in `anvilbox` <sub>or this PR does not require reindexing `sandbox`</sub>
- [ ] Added PR reference to merge commit title
- [ ] Collected commit title tags in merge commit title
- [ ] Moved connected issue to Merged column
Expand All @@ -121,9 +126,13 @@ checklists. Update the `N reviews` label.
### Operator (after pushing the merge commit)

- [ ] Shortened the PR chain <sub>or this PR is not labeled `base`</sub>
- [ ] Pushed merge commit to GitLab <sub>or PR is labeled `no sandbox`</sub>
- [ ] Deleted PR branch from GitHub and GitLab
- [ ] Build passes on GitLab<sup>1</sup>
- [ ] Pushed merge commit to GitLab `dev` <sub>or PR is labeled `no sandbox`</sub>
- [ ] Pushed merge commit to GitLab `anvildev` <sub>or PR is labeled `no sandbox`</sub>
- [ ] Build passes on GitLab `dev`<sup>1</sup>
- [ ] Build passes on GitLab `anvildev`<sup>1</sup>
- [ ] Deleted PR branch from GitHub
- [ ] Deleted PR branch from GitLab `dev`
- [ ] Deleted PR branch from GitLab `anvildev`

<sup>1</sup> When pushing the merge commit is skipped due to the PR being
labelled `no sandbox`, the next build triggered by a PR whose merge commit *is*
Expand All @@ -133,9 +142,13 @@ pushed determines this checklist item.
### Operator (reindex)

- [ ] Deleted unreferenced indices in `dev` <sub>or this PR does not remove catalogs or otherwise causes unreferenced indices</sub>
- [ ] Deleted unreferenced indices in `anvildev` <sub>or this PR does not remove catalogs or otherwise causes unreferenced indices</sub>
- [ ] Started reindex in `dev` <sub>or this PR does not require reindexing</sub>
- [ ] Checked for and triaged indexing failures <sub>or this PR does not require reindexing</sub>
- [ ] Emptied fail queues in target deployment <sub>or this PR does not require reindexing</sub>
- [ ] Started reindex in `anvildev` <sub>or this PR does not require reindexing</sub>
- [ ] Checked for and triaged indexing failures in `dev` <sub>or this PR does not require reindexing</sub>
- [ ] Checked for and triaged indexing failures in `anvildev` <sub>or this PR does not require reindexing</sub>
- [ ] Emptied fail queues in `dev` deployment <sub>or this PR does not require reindexing</sub>
- [ ] Emptied fail queues in `anvildev` deployment <sub>or this PR does not require reindexing</sub>


### Operator
Expand Down

0 comments on commit 372be80

Please sign in to comment.