Skip to content

Commit 1bc73c7

Browse files
authored
Merge pull request #5656 from raft-tech/kennymcnett-release-tracker-issue-template
Add issue template for Release Tracker
2 parents 6b33149 + fc97df8 commit 1bc73c7

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
name: Release Tracker
3+
about: Track the release handoff to OFA, staging validation, and production deployment.
4+
title: Release Tracker vX.X.X
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
# Release Tracker Issue Template
11+
12+
**TITLE:** Release vX.X.X
13+
14+
**CONTENT:**
15+
16+
### 🔗 Included Pull Requests (Dev Team)
17+
*List the PRs included in this release. **Testing instructions for each feature must be located within these linked PRs.***
18+
* #XXX - [Feature/Bugfix Title]
19+
* #XXX - [Feature/Bugfix Title]
20+
21+
### ➡️ URL of GitHub Release Tag:
22+
https://github.com/raft-tech/TANF-app/releases/tag/vX.X.X
23+
24+
---
25+
26+
### 📦 1. Preparation & Handoff (Dev / UX / PM)
27+
*Ensuring the release branch is ready and documented before ACF takes over.*
28+
29+
- [ ] **Release Tagged:** `develop` branch tagged with the new release version.
30+
- [ ] **Release Branch Created:** Branch cut from `develop`.
31+
- [ ] **PR Opened to Staging:** PR opened from the release branch to `HHS:main`.
32+
- [ ] **Testing Instructions Verified:** All linked PRs contain clear testing instructions for ACF validation.
33+
- [ ] **UX/Documentation Check:** UX team has reviewed the PRs, confirmed user-facing changes, and started drafting Release Notes and Knowledge Center guidance.
34+
- [ ] **Migration Flag:** Does this release include a database migration? **[Yes / No]** *(If Yes, rollback from production will be highly complex).*
35+
- [ ] **Handoff Complete:** Issue assigned to @[Alex_username] for Staging validation.
36+
37+
---
38+
39+
### 🧪 2. Staging Validation & QASP (ACF / Alex)
40+
*Tracking the status once ACF takes over deployment and testing.*
41+
42+
- [ ] **Staging Cleared:** Team notified that Staging is about to be updated/restarted.
43+
- [ ] **Deployed to Staging:** PR merged and deployed to the Staging environment.
44+
- [ ] **Feature Validation:** Testing instructions from the linked PRs have been executed and passed.
45+
- [ ] **Regression Validation:** Core workflows (login, submissions, data integrity, etc.) remain functional.
46+
47+
**🐛 Bug Tracking Protocol (If issues are found in Staging):**
48+
1. **Non-Dev Team:** Add a comment on this issue describing the bug/unexpected behavior.
49+
2. **Dev Team:** Review the comment, investigate root cause, and open a formal GitHub Issue.
50+
3. **Triage Decision:**
51+
* *Revert:* If isolated to a new feature, revert the PR out of the release candidate.
52+
* *Hotfix:* Warranted **only if** the bug blocks the release entirely AND the production release is needed ASAP. (Dev cuts hotfix PR against the release branch -> merged to `HHS:main` for re-testing).
53+
54+
- [ ] **Documentation Finalized:** UX team confirms all Release Notes and Knowledge Center updates are finalized and ready for launch.
55+
56+
---
57+
58+
### 🚦 3. Production-Ready Sign-Off
59+
- [ ] ACF/Alex confirms all PRs are validated, no blocking bugs exist, documentation is finalized, and the release is approved for production deployment.
60+
61+
---
62+
63+
### 🛟 4. Rollback & Contingency Reference
64+
*Review before production deployment.*
65+
66+
* **Pipeline/CircleCI Failure:** Retry the pipeline. If it fails again, requires a hotfix to unblock.
67+
* **Missing Config/Secrets (App crashes on boot):** Do not rollback. ACF updates environment variables in the production console and restarts the app.
68+
* **Third-Party API Blocked in Prod:** Dev provides an emergency hotfix to hide the broken UI component.
69+
* **Performance/Database Lockup Under Load:** Dev writes an emergency hotfix for the offending query.
70+
* **Critical Regression Post-Deploy:**
71+
* *No migrations in release:* Rollback the deployment to the previous stable version.
72+
* *Migrations in release:* Rollback is generally not possible; requires an emergency hotfix.
73+
74+
---
75+
76+
### 🚀 5. Production Deployment (ACF / Alex)
77+
*The final deployment executed by ACF.*
78+
79+
- [ ] **Maintenance Mode:** Alex has enabled the maintenance page to ensure users are out of the system.
80+
- [ ] **Deployed to Prod:** PR opened and merged to `HHS:master`, triggering deployment.
81+
- [ ] **Post-Launch Verification:** Quick check that the production environment is stable post-deploy, and the maintenance page is deactivated.
82+
83+
---
84+
85+
### 📢 6. Post-Release Communication (PM / UX / ACF)
86+
*Closing the loop with users and stakeholders.*
87+
88+
- [ ] **Release Notes Published:** (UX team) Plain-language, user-facing release notes and Knowledge Center guidance have been published.
89+
- [ ] **Stakeholders Notified:** (ACF) Any required external communication regarding the new version has been sent.
90+
- [ ] **Close this Issue:** (ACF / PM) The release is fully deployed and stable.

0 commit comments

Comments
 (0)