Skip to content

Commit fffff4a

Browse files
Update release checklist (documentation only) (#7034)
Co-authored-by: Leslie Cohn-Wein <[email protected]>
1 parent 4c4c4cd commit fffff4a

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

.github/release_template.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
11
## ❗ Pre-merge checklist
22

3-
Please ensure these items are checked before merging.
3+
Please ensure these items are checked before merging:
44

55
### 🔎 Smoke test
66

77
- [ ] All CI checks pass on this pull request
88
- [ ] Docs and Storybook open in a browser
9-
- [ ] Works in CodeSandbox or StackBlitz
10-
- [ ] New components render successfully
11-
- [ ] (optional) Tested in both SPA and SSR apps if release contains build changes
129

1310
### 🌏 Integration tests
1411

15-
- [ ] Successful integration test with github/github as a primary consumer of Primer React ([automated pull request](https://github.com/github/github/pulls?q=is%3Apr+is%3Aopen+Integration+tests+for+%40primer%2Freact+release+label%3Adependencies))
12+
- [ ] Successful integration test with github/github-ui as a primary consumer of primer/react ([automated pull request](https://github.com/github/github-ui/pulls?q=is%3Apr+is%3Aopen+author%3Aapp%2Ftest-primer-actions+Integration+tests+for+primer%2Freact+release+primer-react-hourly+github+action+))
1613
- [ ] Verify all CI checks have passed on automated pull request
17-
- [ ] Manually test critical paths in the review-lab
18-
- [ ] Manually test release-specific bugfixes and/or features work as described in the review-lab
14+
- [ ] Manually test critical paths in preview
15+
- [ ] Manually test release-specific bugfixes and/or feature work as described in preview
16+
17+
### ✅ Peer Review
18+
19+
- [ ] Create release review issue for Issues team ([example](https://github.com/github/issues/issues/17817))
20+
- [ ] Wait for approval from Issues team before merging
1921

2022
### 🤔 Sanity test
2123

2224
- [ ] All bugfixes in this release have resolved their corresponding issues
23-
- [ ] The issues for reverted PRs have been re-opened and commented on with a link to the reverted PR
24-
- [ ] No noticeable regressions have not been introduced as a result of changes in this release
25+
- [ ] The issues for any reverted PRs have been re-opened and commented on with a link to the reverted PR
26+
- [ ] No noticeable regressions have been introduced as a result of changes in this release
2527
- [ ] Release notes accurately describe the changes made
2628

27-
### 🚢 After merge
29+
## ❗ Post-merge checklist
2830

29-
- [ ] Upgrade `@primer/react` version at github/github
31+
Please ensure these items are checked after merging:
3032

31-
- [ ] Add the preview deployment's link to releases as a way of permalinking to old version's docs. [Example](https://github.com/primer/react/releases/tag/v35.9.0)
33+
## 🚢 Version upgrade, cleanup, and documentation
3234

33-
Please also leave any testing notes on the weekly [release tracking issue](https://github.com/primer/react/issues?q=is%3Aissue+is%3Aopen+%22Release+Tracking%22). In particular, describing any issues encountered during your testing. This is helpful in providing historical context to the next release conductor as well as maintainers.
35+
- [ ] Upgrade `@primer/react` version at github/github-ui
36+
- [ ] Close Integration test PR and delete branch
37+
- [ ] Leave a `/short-report` comment on [quarterly release conductor tracking issue](https://github.com/github/primer/issues/5977) summarizing time spent on release activities and any challenges encountered
38+
- [ ] Leave any testing notes on the automated [per-shift release tracking issue](https://github.com/primer/react/issues?q=is%3Aissue+is%3Aopen+%22Release+Tracking%22). In particular, describe any issues encountered during your testing. This is helpful in providing historical context to the next release conductor as well as other maintainers.

0 commit comments

Comments
 (0)