codex-genesis-harness 0.1.4 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. package/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -216
  2. package/.codebase/CURRENT_STATE.md +9 -7
  3. package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -161
  4. package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -613
  5. package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -429
  6. package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -351
  7. package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -419
  8. package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -292
  9. package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -486
  10. package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -456
  11. package/.codebase/README.md +139 -139
  12. package/.codebase/RECOVERY_POINTS.md +438 -438
  13. package/.codebase/state.json +37 -0
  14. package/.codex/skills/genesis-api-sync/SKILL.md +354 -354
  15. package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -101
  16. package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -257
  17. package/.codex/skills/genesis-debug-guide/SKILL.md +479 -479
  18. package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -339
  19. package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -210
  20. package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -158
  21. package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -365
  22. package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -289
  23. package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -288
  24. package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -1003
  25. package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -359
  26. package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -312
  27. package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -382
  28. package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -851
  29. package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -491
  30. package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -187
  31. package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -297
  32. package/.codex/skills/genesis-harness/SKILL.md +1427 -1418
  33. package/.codex/skills/genesis-harness/agents/openai.yaml +7 -7
  34. package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -169
  35. package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -157
  36. package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -216
  37. package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -211
  38. package/.codex/skills/genesis-harness/references/planning-schema.md +35 -35
  39. package/.codex/skills/genesis-harness/references/quality-rubric.md +21 -21
  40. package/.codex/skills/genesis-harness/references/research-rubric.md +41 -41
  41. package/.codex/skills/genesis-harness/references/workflows.md +33 -33
  42. package/.codex/skills/genesis-harness/resources/agents-template.md +27 -27
  43. package/.codex/skills/genesis-harness/resources/api-docs-template.md +32 -32
  44. package/.codex/skills/genesis-harness/resources/architecture-template.md +30 -30
  45. package/.codex/skills/genesis-harness/resources/audit-template.md +26 -26
  46. package/.codex/skills/genesis-harness/resources/bug-template.md +34 -34
  47. package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -204
  48. package/.codex/skills/genesis-harness/resources/check-template.md +21 -21
  49. package/.codex/skills/genesis-harness/resources/conventions-template.md +42 -42
  50. package/.codex/skills/genesis-harness/resources/decision-template.md +33 -33
  51. package/.codex/skills/genesis-harness/resources/design-template.md +26 -26
  52. package/.codex/skills/genesis-harness/resources/escalation-template.md +21 -21
  53. package/.codex/skills/genesis-harness/resources/feature-template.md +49 -49
  54. package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -131
  55. package/.codex/skills/genesis-harness/resources/integrations-template.md +32 -32
  56. package/.codex/skills/genesis-harness/resources/journeys-template.md +13 -13
  57. package/.codex/skills/genesis-harness/resources/lessons-learned-template.md +12 -12
  58. package/.codex/skills/genesis-harness/resources/observability-template.md +34 -34
  59. package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -76
  60. package/.codex/skills/genesis-harness/resources/phase-template.md +34 -34
  61. package/.codex/skills/genesis-harness/resources/pitfalls-template.md +22 -22
  62. package/.codex/skills/genesis-harness/resources/planning-tree-template.md +39 -39
  63. package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -347
  64. package/.codex/skills/genesis-harness/resources/project-template.md +38 -38
  65. package/.codex/skills/genesis-harness/resources/quality-score-template.md +11 -11
  66. package/.codex/skills/genesis-harness/resources/requirements-template.md +26 -26
  67. package/.codex/skills/genesis-harness/resources/research-template.md +26 -26
  68. package/.codex/skills/genesis-harness/resources/review-template.md +22 -22
  69. package/.codex/skills/genesis-harness/resources/spec-changelog-template.md +6 -6
  70. package/.codex/skills/genesis-harness/resources/stack-template.md +33 -33
  71. package/.codex/skills/genesis-harness/resources/verification-template.md +26 -26
  72. package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +0 -0
  73. package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +0 -0
  74. package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +0 -0
  75. package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +0 -0
  76. package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +0 -0
  77. package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +0 -0
  78. package/.codex/skills/genesis-harness/scripts/compact-context.sh +0 -0
  79. package/.codex/skills/genesis-harness/scripts/create-adr.sh +0 -0
  80. package/.codex/skills/genesis-harness/scripts/create-bug.sh +0 -0
  81. package/.codex/skills/genesis-harness/scripts/create-feature.sh +0 -0
  82. package/.codex/skills/genesis-harness/scripts/detect-stack.sh +0 -0
  83. package/.codex/skills/genesis-harness/scripts/init-planning.sh +0 -0
  84. package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +0 -0
  85. package/.codex/skills/genesis-harness/scripts/offload-log.sh +0 -0
  86. package/.codex/skills/genesis-harness/scripts/run-verification.sh +0 -0
  87. package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +0 -0
  88. package/.codex/skills/genesis-harness/scripts/update-state.sh +0 -0
  89. package/.codex/skills/genesis-mvp-planning/SKILL.md +114 -0
  90. package/.codex/skills/genesis-mvp-planning/agents/openai.yaml +6 -0
  91. package/.codex/skills/genesis-mvp-planning/checklists/mvp-readiness.md +18 -0
  92. package/.codex/skills/genesis-mvp-planning/examples/5-phase-roadmap-example.md +43 -0
  93. package/.codex/skills/genesis-mvp-planning/templates/phase-1-core.md +17 -0
  94. package/.codex/skills/genesis-mvp-planning/templates/phase-2-auth.md +17 -0
  95. package/.codex/skills/genesis-mvp-planning/templates/phase-3-features.md +17 -0
  96. package/.codex/skills/genesis-mvp-planning/templates/phase-4-integrations.md +17 -0
  97. package/.codex/skills/genesis-mvp-planning/templates/phase-5-readiness.md +17 -0
  98. package/.codex/skills/genesis-new-design/agents/openai.yaml +3 -3
  99. package/.codex/skills/genesis-observability-automation/checklists/.gitkeep +0 -0
  100. package/.codex/skills/genesis-observability-automation/observability/.gitkeep +0 -0
  101. package/.codex/skills/genesis-observability-automation/playbooks/.gitkeep +0 -0
  102. package/.codex/skills/genesis-observability-automation/templates/.gitkeep +0 -0
  103. package/.codex/skills/genesis-release-orchestration/SKILL.md +653 -653
  104. package/.codex/skills/genesis-release-orchestration/checklists/post-deployment-verification.md +274 -274
  105. package/.codex/skills/genesis-release-orchestration/checklists/pre-release-validation.md +220 -220
  106. package/.codex/skills/genesis-release-orchestration/observability/release-tracking.md +253 -253
  107. package/.codex/skills/genesis-release-orchestration/playbooks/canary-deployment-orchestration.md +472 -472
  108. package/.codex/skills/genesis-release-orchestration/playbooks/semantic-versioning-automation.md +494 -494
  109. package/.codex/skills/genesis-release-orchestration/templates/deployment-strategy-template.md +303 -303
  110. package/.codex/skills/genesis-release-orchestration/templates/release-runbook-template.md +420 -420
  111. package/.codex/skills/genesis-research-first/SKILL.md +237 -237
  112. package/.codex/skills/genesis-research-first/templates/.gitkeep +0 -0
  113. package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -534
  114. package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -384
  115. package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -257
  116. package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -373
  117. package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -692
  118. package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -434
  119. package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -407
  120. package/.codex/skills/genesis-state-machine/SKILL.md +34 -0
  121. package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +3 -3
  122. package/.codex/skills/spec-impact-engine/SKILL.md +504 -504
  123. package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +0 -0
  124. package/.codex-plugin/plugin.json +24 -24
  125. package/CHANGELOG.md +42 -0
  126. package/LICENSE +22 -22
  127. package/README.EN.md +784 -719
  128. package/README.VI.md +776 -712
  129. package/README.md +113 -253
  130. package/VERSION +2 -2
  131. package/bin/genesis-harness.js +90 -87
  132. package/package.json +68 -43
  133. package/scripts/README.md +342 -342
  134. package/scripts/compact-context.sh +0 -0
  135. package/scripts/contract_integrity_gate.js +83 -0
  136. package/scripts/detect-changes.sh +0 -0
  137. package/scripts/healing_telemetry.js +118 -0
  138. package/scripts/install.sh +4 -1
  139. package/scripts/offload-log.sh +0 -0
  140. package/scripts/prompt_sentinel.js +84 -0
  141. package/scripts/run-evals.sh +1 -0
  142. package/scripts/run-verify-loop.sh +11 -0
  143. package/scripts/spec_visual_sync.js +157 -0
  144. package/scripts/test_generator.js +142 -0
  145. package/scripts/transition_state.sh +67 -0
  146. package/scripts/uninstall.sh +1 -0
  147. package/scripts/validation_gates.sh +85 -0
  148. package/scripts/verify.sh +5 -0
  149. package/tests/unit/contract_integrity_gate.test.js +74 -0
  150. package/tests/unit/healing_telemetry.test.js +58 -0
  151. package/tests/unit/prompt_sentinel.test.js +50 -0
  152. package/tests/unit/spec_visual_sync.test.js +77 -0
  153. package/tests/unit/test_generator.test.js +62 -0
@@ -1,220 +1,220 @@
1
- # Pre-Release Validation Checklist
2
-
3
- **Purpose**: Verify release readiness before deployment approval
4
- **Duration**: 10-15 minutes
5
- **Risk**: Critical - must pass all checks for approval
6
-
7
- ---
8
-
9
- ## Section 1: Version & Changelog Verification (5 min)
10
-
11
- - [ ] **VERSION file updated correctly**
12
- - Current version in `/VERSION` matches git tag format (v{MAJOR}.{MINOR}.{PATCH})
13
- - Version bump follows semantic versioning (breaking→major, feature→minor, patch→patch)
14
- - No pre-release suffixes without approval (v2.5.0-rc1, etc.)
15
-
16
- - [ ] **Changelog entry exists**
17
- - Entry in `SPEC_CHANGELOG.md` for this version
18
- - Changelog includes: ✨Added, 🔄Changed, 🐛Fixed, ⚠️Deprecated, 🗑️Removed, 🔐Security
19
- - All breaking changes prominently listed
20
- - Migration guide links included for breaking changes
21
- - Release date documented
22
-
23
- - [ ] **Git tags match release version**
24
- - Tag format: `v{MAJOR}.{MINOR}.{PATCH}` (e.g., v2.5.0)
25
- - Tag annotation includes breaking change summary
26
- - Tag created on correct commit (HEAD of main branch)
27
-
28
- ---
29
-
30
- ## Section 2: Code Quality & Testing (5 min)
31
-
32
- - [ ] **Test coverage 80%+ verified**
33
- - Run test suite: All tests pass
34
- - Coverage report generated: 80%+ threshold met
35
- - Critical paths have >90% coverage
36
- - No skipped tests (`.skip()` calls removed)
37
- - E2E tests passing (Phase 5 validation)
38
-
39
- - [ ] **No critical errors in logs**
40
- - Linting passes: No errors, only warnings acceptable
41
- - Type checking passes: All types resolved
42
- - Security scan passing: No vulnerabilities found
43
- - Dependency audit clean: No high-risk dependencies
44
-
45
- - [ ] **Build artifacts valid**
46
- - Docker image builds successfully
47
- - All layers optimized (no bloat)
48
- - Image pushed to registry successfully
49
- - SHA hash recorded for deployment traceability
50
-
51
- ---
52
-
53
- ## Section 3: Breaking Changes & Migration (10 min)
54
-
55
- - [ ] **All breaking changes documented**
56
- - `SPEC_CHANGELOG.md` lists each breaking change:
57
- * What changed (old vs new)
58
- * Why it changed
59
- * Consumer impact
60
- * Migration deadline
61
- - Count: N breaking changes documented
62
-
63
- - [ ] **Migration guides complete** (required if breaking changes >0)
64
- - Guide for each breaking change with:
65
- * Before/after code examples (3+ languages)
66
- * Step-by-step migration instructions
67
- * Common pitfalls section
68
- * Troubleshooting FAQ
69
- * Support contact info
70
- - Migration guides linked in:
71
- * Release notes
72
- * API documentation
73
- * Consumer communication template
74
-
75
- - [ ] **Affected consumers identified & notified**
76
- - Identified: N clients/services affected
77
- - Notified: Consumer list reviewed and approved
78
- - Communication template prepared (email + Slack + in-app banner)
79
- - Support team briefed on incoming migration questions
80
-
81
- - [ ] **Deprecation timeline clear** (for gradual migration)
82
- - If using deprecation period:
83
- * Current version: v2.x (old API still works)
84
- * Deadline version: v3.0 (old API removed)
85
- * Timeline: N months to migrate
86
- - Example: "Old endpoint deprecated in v2.5, removed in v3.0 (6-month timeline)"
87
-
88
- ---
89
-
90
- ## Section 4: Deployment Readiness (5 min)
91
-
92
- - [ ] **Deployment runbooks prepared**
93
- - Runbook exists for: dev, staging, production
94
- - Each runbook includes:
95
- * Pre-deployment steps (DB migrations, config validation)
96
- * Deployment steps (build, push, deploy, restart)
97
- * Post-deployment verification (health checks, smoke tests)
98
- * Rollback procedure (trigger conditions, steps)
99
- - Runbooks reviewed by ops team
100
-
101
- - [ ] **Health checks configured**
102
- - Liveness probe configured: /health (returns 200)
103
- - Readiness probe configured: /ready (checks dependencies)
104
- - Metrics endpoint configured: /metrics (Prometheus format)
105
- - Smoke test scenarios defined (3+ critical workflows)
106
-
107
- - [ ] **Database migrations prepared** (if applicable)
108
- - Migration script exists and tested
109
- - Backward compatible: Can rollback if needed
110
- - Zero-downtime approach: Old code works during migration
111
- - Data integrity verified: No data loss risk
112
- - Estimated duration: <5 min migration window
113
-
114
- - [ ] **Configuration prepared**
115
- - Config files generated for: dev, staging, prod
116
- - Environment-specific values validated:
117
- * Database URLs
118
- * API keys / secrets (via secrets manager)
119
- * Feature flags properly set
120
- * Logging levels appropriate
121
- - No hardcoded values found
122
-
123
- ---
124
-
125
- ## Section 5: Rollback Capability (5 min)
126
-
127
- - [ ] **Rollback plan tested**
128
- - Rollback triggers defined: error rate >5%, latency >2s, health check fail
129
- - Rollback steps documented and verified
130
- - Previous version artifacts available: Docker image, config, DB state
131
- - Rollback time: <5 minutes verified
132
- - Rollback reverses all changes: code, config, DB state
133
-
134
- - [ ] **Deployment strategy matches risk**
135
- - Risk score calculated: N/10
136
- - Strategy selected:
137
- * Low (1-2): Rolling deployment
138
- * Medium (3-5): Blue-green deployment
139
- * High (6-8): Canary (1%→10%→50%→100%)
140
- * Critical (9-10): Scheduled deployment + manual approval at each stage
141
- - Strategy team-reviewed and approved
142
-
143
- - [ ] **Monitoring configured**
144
- - Dashboard created for deployment monitoring
145
- - Alerts configured for error rate spike
146
- - Alert thresholds set: >5% error rate = trigger alert
147
- - Team on-call for deployment window
148
- - Escalation path defined
149
-
150
- ---
151
-
152
- ## Section 6: Approvals & Sign-Off (5 min)
153
-
154
- - [ ] **Required approvals obtained**
155
- - Risk score: N/10
156
- - Approval required from:
157
- * Low (1-2): Tech Lead (or auto-approve)
158
- * Medium (3-5): Tech Lead + Lead Engineer
159
- * High (6-8): Tech Lead + Product Lead
160
- * Critical (9-10): CTO + scheduled window approval
161
- - All approvers signed off with timestamp
162
-
163
- - [ ] **Deployment window scheduled**
164
- - If breaking changes: scheduled deployment window
165
- - Team availability: All on-call resources available
166
- - Communication: Consumers notified of maintenance window (if needed)
167
- - Rollback team: Same team on standby for 1 hour post-deployment
168
-
169
- - [ ] **Documentation complete**
170
- - Release notes ready (version, what's new, what's fixed, breaking changes)
171
- - Consumer communication sent (email + Slack + notification)
172
- - Internal team briefed: engineering, support, ops
173
- - External status page updated (if consumer-facing)
174
-
175
- ---
176
-
177
- ## Red Flags - STOP if any present
178
-
179
- ❌ **MUST STOP - Do not proceed to deployment**:
180
-
181
- - [ ] Test coverage <80% (BLOCKER)
182
- - [ ] Breaking changes undocumented (BLOCKER)
183
- - [ ] Migration guides missing for breaking changes (BLOCKER)
184
- - [ ] Rollback plan untested (BLOCKER)
185
- - [ ] Required approvals missing (BLOCKER)
186
- - [ ] Version bump doesn't match semantic versioning (BLOCKER)
187
- - [ ] Critical errors in logs/build (BLOCKER)
188
- - [ ] Database rollback impossible (HIGH RISK)
189
- - [ ] Consumers not notified of breaking changes (HIGH RISK)
190
-
191
- **If STOP condition found**:
192
- 1. Identify blocking issue
193
- 2. Take corrective action
194
- 3. Re-run validation checklist
195
- 4. Do not deploy until all checks pass
196
-
197
- ---
198
-
199
- ## Sign-Off Template
200
-
201
- ```
202
- RELEASE: v2.5.0
203
- DATE: 2026-05-31
204
- CHECKED BY: [Name]
205
- APPROVED BY: [Name] (Tech Lead)
206
-
207
- Version verification: ✓ PASS
208
- Test coverage: ✓ PASS (82%)
209
- Breaking changes documented: ✓ PASS (2 breaking changes)
210
- Deployment runbook: ✓ PASS
211
- Rollback tested: ✓ PASS
212
- Approvals obtained: ✓ PASS
213
-
214
- Risk Score: 6/10 (HIGH - canary deployment)
215
- Status: ✅ APPROVED FOR DEPLOYMENT
216
-
217
- Next step: Begin canary deployment (Stage 1: 1% traffic)
218
- Monitoring window: 1 hour
219
- Rollback team: On standby
220
- ```
1
+ # Pre-Release Validation Checklist
2
+
3
+ **Purpose**: Verify release readiness before deployment approval
4
+ **Duration**: 10-15 minutes
5
+ **Risk**: Critical - must pass all checks for approval
6
+
7
+ ---
8
+
9
+ ## Section 1: Version & Changelog Verification (5 min)
10
+
11
+ - [ ] **VERSION file updated correctly**
12
+ - Current version in `/VERSION` matches git tag format (v{MAJOR}.{MINOR}.{PATCH})
13
+ - Version bump follows semantic versioning (breaking→major, feature→minor, patch→patch)
14
+ - No pre-release suffixes without approval (v2.5.0-rc1, etc.)
15
+
16
+ - [ ] **Changelog entry exists**
17
+ - Entry in `SPEC_CHANGELOG.md` for this version
18
+ - Changelog includes: ✨Added, 🔄Changed, 🐛Fixed, ⚠️Deprecated, 🗑️Removed, 🔐Security
19
+ - All breaking changes prominently listed
20
+ - Migration guide links included for breaking changes
21
+ - Release date documented
22
+
23
+ - [ ] **Git tags match release version**
24
+ - Tag format: `v{MAJOR}.{MINOR}.{PATCH}` (e.g., v2.5.0)
25
+ - Tag annotation includes breaking change summary
26
+ - Tag created on correct commit (HEAD of main branch)
27
+
28
+ ---
29
+
30
+ ## Section 2: Code Quality & Testing (5 min)
31
+
32
+ - [ ] **Test coverage 80%+ verified**
33
+ - Run test suite: All tests pass
34
+ - Coverage report generated: 80%+ threshold met
35
+ - Critical paths have >90% coverage
36
+ - No skipped tests (`.skip()` calls removed)
37
+ - E2E tests passing (Phase 5 validation)
38
+
39
+ - [ ] **No critical errors in logs**
40
+ - Linting passes: No errors, only warnings acceptable
41
+ - Type checking passes: All types resolved
42
+ - Security scan passing: No vulnerabilities found
43
+ - Dependency audit clean: No high-risk dependencies
44
+
45
+ - [ ] **Build artifacts valid**
46
+ - Docker image builds successfully
47
+ - All layers optimized (no bloat)
48
+ - Image pushed to registry successfully
49
+ - SHA hash recorded for deployment traceability
50
+
51
+ ---
52
+
53
+ ## Section 3: Breaking Changes & Migration (10 min)
54
+
55
+ - [ ] **All breaking changes documented**
56
+ - `SPEC_CHANGELOG.md` lists each breaking change:
57
+ * What changed (old vs new)
58
+ * Why it changed
59
+ * Consumer impact
60
+ * Migration deadline
61
+ - Count: N breaking changes documented
62
+
63
+ - [ ] **Migration guides complete** (required if breaking changes >0)
64
+ - Guide for each breaking change with:
65
+ * Before/after code examples (3+ languages)
66
+ * Step-by-step migration instructions
67
+ * Common pitfalls section
68
+ * Troubleshooting FAQ
69
+ * Support contact info
70
+ - Migration guides linked in:
71
+ * Release notes
72
+ * API documentation
73
+ * Consumer communication template
74
+
75
+ - [ ] **Affected consumers identified & notified**
76
+ - Identified: N clients/services affected
77
+ - Notified: Consumer list reviewed and approved
78
+ - Communication template prepared (email + Slack + in-app banner)
79
+ - Support team briefed on incoming migration questions
80
+
81
+ - [ ] **Deprecation timeline clear** (for gradual migration)
82
+ - If using deprecation period:
83
+ * Current version: v2.x (old API still works)
84
+ * Deadline version: v3.0 (old API removed)
85
+ * Timeline: N months to migrate
86
+ - Example: "Old endpoint deprecated in v2.5, removed in v3.0 (6-month timeline)"
87
+
88
+ ---
89
+
90
+ ## Section 4: Deployment Readiness (5 min)
91
+
92
+ - [ ] **Deployment runbooks prepared**
93
+ - Runbook exists for: dev, staging, production
94
+ - Each runbook includes:
95
+ * Pre-deployment steps (DB migrations, config validation)
96
+ * Deployment steps (build, push, deploy, restart)
97
+ * Post-deployment verification (health checks, smoke tests)
98
+ * Rollback procedure (trigger conditions, steps)
99
+ - Runbooks reviewed by ops team
100
+
101
+ - [ ] **Health checks configured**
102
+ - Liveness probe configured: /health (returns 200)
103
+ - Readiness probe configured: /ready (checks dependencies)
104
+ - Metrics endpoint configured: /metrics (Prometheus format)
105
+ - Smoke test scenarios defined (3+ critical workflows)
106
+
107
+ - [ ] **Database migrations prepared** (if applicable)
108
+ - Migration script exists and tested
109
+ - Backward compatible: Can rollback if needed
110
+ - Zero-downtime approach: Old code works during migration
111
+ - Data integrity verified: No data loss risk
112
+ - Estimated duration: <5 min migration window
113
+
114
+ - [ ] **Configuration prepared**
115
+ - Config files generated for: dev, staging, prod
116
+ - Environment-specific values validated:
117
+ * Database URLs
118
+ * API keys / secrets (via secrets manager)
119
+ * Feature flags properly set
120
+ * Logging levels appropriate
121
+ - No hardcoded values found
122
+
123
+ ---
124
+
125
+ ## Section 5: Rollback Capability (5 min)
126
+
127
+ - [ ] **Rollback plan tested**
128
+ - Rollback triggers defined: error rate >5%, latency >2s, health check fail
129
+ - Rollback steps documented and verified
130
+ - Previous version artifacts available: Docker image, config, DB state
131
+ - Rollback time: <5 minutes verified
132
+ - Rollback reverses all changes: code, config, DB state
133
+
134
+ - [ ] **Deployment strategy matches risk**
135
+ - Risk score calculated: N/10
136
+ - Strategy selected:
137
+ * Low (1-2): Rolling deployment
138
+ * Medium (3-5): Blue-green deployment
139
+ * High (6-8): Canary (1%→10%→50%→100%)
140
+ * Critical (9-10): Scheduled deployment + manual approval at each stage
141
+ - Strategy team-reviewed and approved
142
+
143
+ - [ ] **Monitoring configured**
144
+ - Dashboard created for deployment monitoring
145
+ - Alerts configured for error rate spike
146
+ - Alert thresholds set: >5% error rate = trigger alert
147
+ - Team on-call for deployment window
148
+ - Escalation path defined
149
+
150
+ ---
151
+
152
+ ## Section 6: Approvals & Sign-Off (5 min)
153
+
154
+ - [ ] **Required approvals obtained**
155
+ - Risk score: N/10
156
+ - Approval required from:
157
+ * Low (1-2): Tech Lead (or auto-approve)
158
+ * Medium (3-5): Tech Lead + Lead Engineer
159
+ * High (6-8): Tech Lead + Product Lead
160
+ * Critical (9-10): CTO + scheduled window approval
161
+ - All approvers signed off with timestamp
162
+
163
+ - [ ] **Deployment window scheduled**
164
+ - If breaking changes: scheduled deployment window
165
+ - Team availability: All on-call resources available
166
+ - Communication: Consumers notified of maintenance window (if needed)
167
+ - Rollback team: Same team on standby for 1 hour post-deployment
168
+
169
+ - [ ] **Documentation complete**
170
+ - Release notes ready (version, what's new, what's fixed, breaking changes)
171
+ - Consumer communication sent (email + Slack + notification)
172
+ - Internal team briefed: engineering, support, ops
173
+ - External status page updated (if consumer-facing)
174
+
175
+ ---
176
+
177
+ ## Red Flags - STOP if any present
178
+
179
+ ❌ **MUST STOP - Do not proceed to deployment**:
180
+
181
+ - [ ] Test coverage <80% (BLOCKER)
182
+ - [ ] Breaking changes undocumented (BLOCKER)
183
+ - [ ] Migration guides missing for breaking changes (BLOCKER)
184
+ - [ ] Rollback plan untested (BLOCKER)
185
+ - [ ] Required approvals missing (BLOCKER)
186
+ - [ ] Version bump doesn't match semantic versioning (BLOCKER)
187
+ - [ ] Critical errors in logs/build (BLOCKER)
188
+ - [ ] Database rollback impossible (HIGH RISK)
189
+ - [ ] Consumers not notified of breaking changes (HIGH RISK)
190
+
191
+ **If STOP condition found**:
192
+ 1. Identify blocking issue
193
+ 2. Take corrective action
194
+ 3. Re-run validation checklist
195
+ 4. Do not deploy until all checks pass
196
+
197
+ ---
198
+
199
+ ## Sign-Off Template
200
+
201
+ ```
202
+ RELEASE: v2.5.0
203
+ DATE: 2026-05-31
204
+ CHECKED BY: [Name]
205
+ APPROVED BY: [Name] (Tech Lead)
206
+
207
+ Version verification: ✓ PASS
208
+ Test coverage: ✓ PASS (82%)
209
+ Breaking changes documented: ✓ PASS (2 breaking changes)
210
+ Deployment runbook: ✓ PASS
211
+ Rollback tested: ✓ PASS
212
+ Approvals obtained: ✓ PASS
213
+
214
+ Risk Score: 6/10 (HIGH - canary deployment)
215
+ Status: ✅ APPROVED FOR DEPLOYMENT
216
+
217
+ Next step: Begin canary deployment (Stage 1: 1% traffic)
218
+ Monitoring window: 1 hour
219
+ Rollback team: On standby
220
+ ```