codex-genesis-harness 0.1.5 → 0.1.7

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 (178) hide show
  1. package/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -216
  2. package/.codebase/CURRENT_STATE.md +8 -2
  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 +83 -438
  13. package/.codebase/beads.json +16 -0
  14. package/.codex/skills/genesis-ai-provider/SKILL.md +1 -1
  15. package/.codex/skills/genesis-api-contract/SKILL.md +1 -1
  16. package/.codex/skills/genesis-api-sync/SKILL.md +354 -354
  17. package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -101
  18. package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -257
  19. package/.codex/skills/genesis-architecture/SKILL.md +1 -1
  20. package/.codex/skills/genesis-codebase-map/SKILL.md +1 -1
  21. package/.codex/skills/genesis-debug-guide/SKILL.md +479 -479
  22. package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -339
  23. package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -210
  24. package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -158
  25. package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -365
  26. package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -289
  27. package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -288
  28. package/.codex/skills/genesis-design-spec/SKILL.md +3 -3
  29. package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -1003
  30. package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -359
  31. package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -312
  32. package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -382
  33. package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -851
  34. package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -491
  35. package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -187
  36. package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -297
  37. package/.codex/skills/genesis-harness/SKILL.md +1428 -1427
  38. package/.codex/skills/genesis-harness/agents/openai.yaml +7 -7
  39. package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -169
  40. package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -157
  41. package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -216
  42. package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -211
  43. package/.codex/skills/genesis-harness/references/planning-schema.md +35 -35
  44. package/.codex/skills/genesis-harness/references/quality-rubric.md +21 -21
  45. package/.codex/skills/genesis-harness/references/research-rubric.md +41 -41
  46. package/.codex/skills/genesis-harness/references/workflows.md +33 -33
  47. package/.codex/skills/genesis-harness/resources/agents-template.md +27 -27
  48. package/.codex/skills/genesis-harness/resources/api-docs-template.md +32 -32
  49. package/.codex/skills/genesis-harness/resources/architecture-template.md +30 -30
  50. package/.codex/skills/genesis-harness/resources/audit-template.md +26 -26
  51. package/.codex/skills/genesis-harness/resources/bug-template.md +34 -34
  52. package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -204
  53. package/.codex/skills/genesis-harness/resources/check-template.md +21 -21
  54. package/.codex/skills/genesis-harness/resources/conventions-template.md +42 -42
  55. package/.codex/skills/genesis-harness/resources/decision-template.md +33 -33
  56. package/.codex/skills/genesis-harness/resources/design-template.md +26 -26
  57. package/.codex/skills/genesis-harness/resources/escalation-template.md +21 -21
  58. package/.codex/skills/genesis-harness/resources/feature-template.md +49 -49
  59. package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -131
  60. package/.codex/skills/genesis-harness/resources/integrations-template.md +32 -32
  61. package/.codex/skills/genesis-harness/resources/journeys-template.md +13 -13
  62. package/.codex/skills/genesis-harness/resources/lessons-learned-template.md +12 -12
  63. package/.codex/skills/genesis-harness/resources/observability-template.md +34 -34
  64. package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -76
  65. package/.codex/skills/genesis-harness/resources/phase-template.md +34 -34
  66. package/.codex/skills/genesis-harness/resources/pitfalls-template.md +22 -22
  67. package/.codex/skills/genesis-harness/resources/planning-tree-template.md +39 -39
  68. package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -347
  69. package/.codex/skills/genesis-harness/resources/project-template.md +38 -38
  70. package/.codex/skills/genesis-harness/resources/quality-score-template.md +11 -11
  71. package/.codex/skills/genesis-harness/resources/requirements-template.md +26 -26
  72. package/.codex/skills/genesis-harness/resources/research-template.md +26 -26
  73. package/.codex/skills/genesis-harness/resources/review-template.md +22 -22
  74. package/.codex/skills/genesis-harness/resources/spec-changelog-template.md +6 -6
  75. package/.codex/skills/genesis-harness/resources/stack-template.md +33 -33
  76. package/.codex/skills/genesis-harness/resources/verification-template.md +26 -26
  77. package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +0 -0
  78. package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +0 -0
  79. package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +0 -0
  80. package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +0 -0
  81. package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +0 -0
  82. package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +0 -0
  83. package/.codex/skills/genesis-harness/scripts/compact-context.sh +0 -0
  84. package/.codex/skills/genesis-harness/scripts/create-adr.sh +0 -0
  85. package/.codex/skills/genesis-harness/scripts/create-bug.sh +0 -0
  86. package/.codex/skills/genesis-harness/scripts/create-feature.sh +0 -0
  87. package/.codex/skills/genesis-harness/scripts/detect-stack.sh +0 -0
  88. package/.codex/skills/genesis-harness/scripts/init-planning.sh +0 -0
  89. package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +0 -0
  90. package/.codex/skills/genesis-harness/scripts/offload-log.sh +0 -0
  91. package/.codex/skills/genesis-harness/scripts/run-verification.sh +0 -0
  92. package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +0 -0
  93. package/.codex/skills/genesis-harness/scripts/update-state.sh +0 -0
  94. package/.codex/skills/genesis-harness-engineering/SKILL.md +1 -1
  95. package/.codex/skills/genesis-new-design/SKILL.md +2 -1
  96. package/.codex/skills/genesis-new-design/agents/openai.yaml +3 -3
  97. package/.codex/skills/genesis-observability-automation/checklists/.gitkeep +0 -0
  98. package/.codex/skills/genesis-observability-automation/observability/.gitkeep +0 -0
  99. package/.codex/skills/genesis-observability-automation/playbooks/.gitkeep +0 -0
  100. package/.codex/skills/genesis-observability-automation/templates/.gitkeep +0 -0
  101. package/.codex/skills/genesis-pipeline-orchestration/SKILL.md +1 -1
  102. package/.codex/skills/genesis-planning/SKILL.md +26 -1
  103. package/.codex/skills/genesis-planning/checklists/mvp-readiness.md +18 -0
  104. package/.codex/skills/genesis-planning/examples/5-phase-roadmap-example.md +43 -0
  105. package/.codex/skills/genesis-planning/templates/phase-1-core.md +17 -0
  106. package/.codex/skills/genesis-planning/templates/phase-2-auth.md +17 -0
  107. package/.codex/skills/genesis-planning/templates/phase-3-features.md +17 -0
  108. package/.codex/skills/genesis-planning/templates/phase-4-integrations.md +17 -0
  109. package/.codex/skills/genesis-planning/templates/phase-5-readiness.md +17 -0
  110. package/.codex/skills/genesis-release/SKILL.md +24 -1
  111. package/.codex/skills/{genesis-release-orchestration → genesis-release}/checklists/post-deployment-verification.md +274 -274
  112. package/.codex/skills/{genesis-release-orchestration → genesis-release}/checklists/pre-release-validation.md +220 -220
  113. package/.codex/skills/{genesis-release-orchestration → genesis-release}/observability/release-tracking.md +253 -253
  114. package/.codex/skills/{genesis-release-orchestration → genesis-release}/playbooks/canary-deployment-orchestration.md +472 -472
  115. package/.codex/skills/{genesis-release-orchestration → genesis-release}/playbooks/semantic-versioning-automation.md +494 -494
  116. package/.codex/skills/{genesis-release-orchestration → genesis-release}/templates/deployment-strategy-template.md +303 -303
  117. package/.codex/skills/{genesis-release-orchestration → genesis-release}/templates/release-runbook-template.md +420 -420
  118. package/.codex/skills/genesis-research-first/SKILL.md +237 -237
  119. package/.codex/skills/genesis-research-first/templates/.gitkeep +0 -0
  120. package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -534
  121. package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -384
  122. package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -257
  123. package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -373
  124. package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -692
  125. package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -434
  126. package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -407
  127. package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/SKILL.md +1 -1
  128. package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +3 -3
  129. package/.codex/skills/spec-impact-engine/SKILL.md +504 -504
  130. package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +0 -0
  131. package/.codex-plugin/plugin.json +19 -19
  132. package/CHANGELOG.md +56 -0
  133. package/LICENSE +22 -22
  134. package/README.EN.md +780 -730
  135. package/README.VI.md +772 -723
  136. package/README.md +102 -247
  137. package/VERSION +2 -2
  138. package/bin/genesis-harness.js +695 -92
  139. package/package.json +9 -3
  140. package/scripts/README.md +342 -342
  141. package/scripts/compact-context.sh +0 -0
  142. package/scripts/contract_integrity_gate.js +83 -0
  143. package/scripts/detect-changes.sh +0 -0
  144. package/scripts/healing_telemetry.js +118 -0
  145. package/scripts/install.sh +5 -6
  146. package/scripts/offload-log.sh +0 -0
  147. package/scripts/prompt_sentinel.js +84 -0
  148. package/scripts/run-evals.sh +20 -24
  149. package/scripts/run-verify-loop.sh +11 -0
  150. package/scripts/spec_visual_sync.js +157 -0
  151. package/scripts/test_generator.js +142 -0
  152. package/scripts/transition_state.sh +0 -0
  153. package/scripts/uninstall.sh +2 -5
  154. package/scripts/validation_gates.sh +40 -1
  155. package/scripts/verify.sh +6 -61
  156. package/tests/unit/contract_integrity_gate.test.js +74 -0
  157. package/tests/unit/healing_telemetry.test.js +58 -0
  158. package/tests/unit/prompt_sentinel.test.js +50 -0
  159. package/tests/unit/spec_visual_sync.test.js +77 -0
  160. package/tests/unit/test_generator.test.js +62 -0
  161. package/.codex/skills/genesis-docs/SKILL.md +0 -46
  162. package/.codex/skills/genesis-docs/agents/openai.yaml +0 -7
  163. package/.codex/skills/genesis-release-orchestration/SKILL.md +0 -653
  164. package/.codex/skills/genesis-release-orchestration/agents/openai.yaml +0 -7
  165. package/.codex/skills/genesis-research/SKILL.md +0 -46
  166. package/.codex/skills/genesis-research/agents/openai.yaml +0 -7
  167. /package/.codex/skills/{genesis-docs/checklists/checklist.md → genesis-docs-automation/checklists/manual-docs-checklist.md} +0 -0
  168. /package/.codex/skills/{genesis-docs/examples/example.md → genesis-docs-automation/examples/manual-docs-example.md} +0 -0
  169. /package/.codex/skills/{genesis-docs → genesis-docs-automation}/templates/docs-update-template.md +0 -0
  170. /package/.codex/skills/{genesis-state-machine/SKILL.md → genesis-harness/references/state-machine.md} +0 -0
  171. /package/.codex/skills/{genesis-release-orchestration/examples/example.md → genesis-release/examples/orchestration-example.md} +0 -0
  172. /package/.codex/skills/{genesis-research → genesis-research-first}/checklists/checklist.md +0 -0
  173. /package/.codex/skills/{genesis-research/examples/example.md → genesis-research-first/examples/manual-research-example.md} +0 -0
  174. /package/.codex/skills/{genesis-research → genesis-research-first}/templates/research-note-template.md +0 -0
  175. /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/agents/openai.yaml +0 -0
  176. /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/checklists/checklist.md +0 -0
  177. /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/examples/example.md +0 -0
  178. /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/templates/playwright-test-template.md +0 -0
@@ -1,253 +1,253 @@
1
- # Release Tracking & Observability
2
-
3
- **Purpose**: Log, track, and analyze all release deployments
4
- **Format**: Machine-readable for automation, human-readable for review
5
- **Retention**: 12 months (archive older)
6
-
7
- ---
8
-
9
- ## RELEASE_LOG.md Format
10
-
11
- ```markdown
12
- # Release Deployment Log
13
-
14
- ## v3.0.0 - May 31, 2026
15
-
16
- **Metadata**:
17
- - Date: 2026-05-31
18
- - Version: v3.0.0
19
- - Strategy: Canary (1%→10%→50%→100%)
20
- - Risk Score: 7/10 (HIGH)
21
- - Breaking Changes: 2
22
- - Approvals: Tech Lead (John Doe), Product Lead (Jane Smith)
23
- - Status: ✅ COMPLETE
24
- - Duration: 8 hours 30 minutes
25
-
26
- **Changes Summary**:
27
- - Removed: POST /users/:id/avatar endpoint
28
- - Changed: Response format { user: {...} } → { data: {...} }
29
- - Added: PATCH /users/:id/profile endpoint
30
- - Fixed: User role permission bug
31
-
32
- **Deployment Details**:
33
- - Stage 1: 1% traffic, 1 hour, ✅ PASS
34
- - Stage 2: 10% traffic, 2 hours, ✅ PASS
35
- - Stage 3: 50% traffic, 4 hours, ✅ PASS
36
- - Stage 4: 100% traffic, 24+ hours, ✅ PASS
37
-
38
- **Metrics**:
39
- - Error Rate: 0.08% (target <1%) ✅
40
- - Latency P95: 191ms (target <200ms) ✅
41
- - Availability: 99.92%
42
- - Issues: None
43
- - Rollback: Not required
44
-
45
- **Consumers Migrated**:
46
- - WebApp: ✅ Updated (deployed v[X] with response parsing fix)
47
- - Mobile: ✅ Already on v1.3+
48
- - Dashboard: ✅ Updated
49
- - Admin: ✅ Updated
50
- - Partners: ⏳ In progress (2/3 clients migrated)
51
-
52
- **Post-Deployment**:
53
- - Monitoring window: 24 hours
54
- - All checks: ✅ PASS
55
- - Team stood down: 2026-06-01 18:00 UTC
56
- - Previous version decommissioned: 2026-06-01 20:00 UTC
57
-
58
- ---
59
-
60
- ## v2.5.3 - May 15, 2026
61
-
62
- **Status**: ✅ COMPLETE (patch release)
63
- ...
64
- ```
65
-
66
- ---
67
-
68
- ## release-metrics.csv Format
69
-
70
- ```csv
71
- date,version,strategy,risk_score,breaking_changes,affected_consumers,duration_hours,error_rate_pct,latency_p95_ms,issues_count,rollback_required,approval_chain,status
72
- 2026-05-31,v3.0.0,canary,7,2,12,8.5,0.08,191,0,false,TL+PL,complete
73
- 2026-05-15,v2.5.3,rolling,2,0,0,2.0,0.06,185,0,false,TL,complete
74
- 2026-05-01,v2.5.2,rolling,1,0,0,1.5,0.07,187,0,false,auto,complete
75
- 2026-04-15,v2.5.1,blue-green,3,1,3,3.0,0.09,192,1,false,TL+PL,complete
76
- 2026-04-01,v2.5.0,canary,6,1,8,9.0,0.08,190,0,false,TL+PL+CTO,complete
77
- ```
78
-
79
- ---
80
-
81
- ## Monthly Health Report Template
82
-
83
- ```markdown
84
- # Release Health Report - May 2026
85
-
86
- ## Summary
87
-
88
- | Metric | May 2026 | April 2026 | Trend |
89
- |--------|----------|-----------|-------|
90
- | Releases | 5 | 4 | ↑ 25% |
91
- | Avg Risk Score | 3.8/10 | 4.2/10 | ↓ Improving |
92
- | Avg Error Rate | 0.077% | 0.081% | ↓ Improving |
93
- | Avg Latency P95 | 189ms | 194ms | ↓ Improving |
94
- | Rollback Rate | 0% | 0% | = Stable |
95
- | Avg Deploy Time | 3.5 hrs | 4.1 hrs | ↓ Faster |
96
- | Consumer Migration Success | 99.5% | 97% | ↑ Improving |
97
-
98
- ---
99
-
100
- ## May Releases
101
-
102
- ### v3.0.0 - May 31 (MAJOR)
103
- - Strategy: Canary
104
- - Duration: 8.5 hours
105
- - Status: ✅ Success
106
- - Issues: None
107
-
108
- ### v2.5.3 - May 15 (PATCH)
109
- - Strategy: Rolling
110
- - Duration: 2 hours
111
- - Status: ✅ Success
112
- - Issues: None
113
-
114
- ### v2.5.2 - May 1 (PATCH)
115
- - Strategy: Rolling
116
- - Duration: 1.5 hours
117
- - Status: ✅ Success
118
- - Issues: None (bug fix)
119
-
120
- ---
121
-
122
- ## Performance Trends
123
-
124
- ### Deployment Duration (Hours)
125
-
126
- ```
127
- May 31: 8.5 (canary v3.0.0, complex)
128
- May 15: 2.0 (rolling v2.5.3, simple)
129
- May 1: 1.5 (rolling v2.5.2, simple)
130
- Apr 15: 3.0 (blue-green v2.5.1, medium)
131
- Apr 1: 9.0 (canary v2.5.0, complex)
132
-
133
- Average: 4.8 hours → Targeting: 3.5 hours
134
- ```
135
-
136
- ### Error Rates (%)
137
-
138
- ```
139
- May avg: 0.077%
140
- Apr avg: 0.081%
141
- Mar avg: 0.095%
142
-
143
- Trend: ↓ Improving (better automation, earlier detection)
144
- Target: <0.05% by Q3 2026
145
- ```
146
-
147
- ### Rollback Rate (%)
148
-
149
- ```
150
- May: 0% (5/5 successful, no rollbacks)
151
- Apr: 0% (4/4 successful, no rollbacks)
152
- Mar: 20% (1/5 rolled back due to API format issue)
153
-
154
- Trend: ↑ Improving (pre-deployment validation preventing failures)
155
- ```
156
-
157
- ---
158
-
159
- ## Improvement Opportunities
160
-
161
- 1. **Deployment Automation**: Canary stages could be automated further (currently manual decisions)
162
- - Expected savings: 2+ hours per release
163
- - Effort: Medium (auto-go criteria definition)
164
-
165
- 2. **Consumer Migration**: Manual tracking of consumer updates
166
- - Expected savings: 1 hour per breaking change release
167
- - Effort: High (requires consumer API integration)
168
-
169
- 3. **Database Migrations**: Currently manual (could auto-rollback if data inconsistency detected)
170
- - Expected savings: 30 min per migration
171
- - Effort: High (complex, risky)
172
-
173
- ---
174
-
175
- ## Queries & Analytics
176
-
177
- ### Find all BREAKING releases in past 30 days
178
- ```
179
- SELECT * FROM release_metrics
180
- WHERE date > DATE('2026-05-01')
181
- AND breaking_changes > 0
182
- ORDER BY date DESC;
183
-
184
- Result: v3.0.0 (2 breaking), v2.5.1 (1 breaking)
185
- ```
186
-
187
- ### Find releases with longest deployment time
188
- ```
189
- SELECT date, version, strategy, duration_hours, risk_score
190
- FROM release_metrics
191
- ORDER BY duration_hours DESC
192
- LIMIT 5;
193
-
194
- Result:
195
- - v2.5.0: 9.0 hours (canary, risk 6)
196
- - v3.0.0: 8.5 hours (canary, risk 7)
197
- - v2.5.1: 3.0 hours (blue-green, risk 3)
198
- ```
199
-
200
- ### Calculate average deployment time by strategy
201
- ```
202
- SELECT strategy, COUNT(*) as count, AVG(duration_hours) as avg_duration
203
- FROM release_metrics
204
- GROUP BY strategy
205
- ORDER BY avg_duration DESC;
206
-
207
- Result:
208
- - Canary: avg 8.75 hours (2 releases)
209
- - Blue-Green: avg 3.0 hours (1 release)
210
- - Rolling: avg 1.67 hours (2 releases)
211
- ```
212
-
213
- ### Find releases with issues
214
- ```
215
- SELECT date, version, issues_count, rollback_required, status
216
- FROM release_metrics
217
- WHERE issues_count > 0 OR rollback_required = true;
218
-
219
- Result: None in May 2026 (all clean)
220
- ```
221
-
222
- ---
223
-
224
- ## Monthly Highlights
225
-
226
- ✅ **Successes**:
227
- - 5 releases completed without rollbacks
228
- - v3.0.0 (major, breaking) deployed successfully with canary strategy
229
- - 99.5% consumer migration success rate
230
- - Error rates improving month-over-month
231
-
232
- ⚠️ **Opportunities**:
233
- - Reduce canary deployment time (currently 8+ hours for high-risk)
234
- - Automate consumer migration tracking
235
- - Enhance pre-deployment validation
236
-
237
- 🎯 **Targets for June**:
238
- - Reduce avg deployment time to 3 hours (vs 4.8 current)
239
- - Maintain 0% rollback rate
240
- - 100% consumer migration for breaking changes
241
- - Implement auto-canary-stage-progression
242
-
243
- ---
244
-
245
- ## Archive Strategy
246
-
247
- - **Recent** (< 3 months): Keep in RELEASE_LOG.md + release-metrics.csv
248
- - **Aging** (3-12 months): Archive to release-metrics-2026-Q1.csv.gz
249
- - **Archived** (> 12 months): Store in S3, reference in historical reports
250
-
251
- Example:
252
- - 2026 Q1: release-metrics-2026-Q1.csv.gz (archived May 2026)
253
- - 2025 Q4: release-metrics-2025-Q4.csv.gz (archived Feb 2026)
1
+ # Release Tracking & Observability
2
+
3
+ **Purpose**: Log, track, and analyze all release deployments
4
+ **Format**: Machine-readable for automation, human-readable for review
5
+ **Retention**: 12 months (archive older)
6
+
7
+ ---
8
+
9
+ ## RELEASE_LOG.md Format
10
+
11
+ ```markdown
12
+ # Release Deployment Log
13
+
14
+ ## v3.0.0 - May 31, 2026
15
+
16
+ **Metadata**:
17
+ - Date: 2026-05-31
18
+ - Version: v3.0.0
19
+ - Strategy: Canary (1%→10%→50%→100%)
20
+ - Risk Score: 7/10 (HIGH)
21
+ - Breaking Changes: 2
22
+ - Approvals: Tech Lead (John Doe), Product Lead (Jane Smith)
23
+ - Status: ✅ COMPLETE
24
+ - Duration: 8 hours 30 minutes
25
+
26
+ **Changes Summary**:
27
+ - Removed: POST /users/:id/avatar endpoint
28
+ - Changed: Response format { user: {...} } → { data: {...} }
29
+ - Added: PATCH /users/:id/profile endpoint
30
+ - Fixed: User role permission bug
31
+
32
+ **Deployment Details**:
33
+ - Stage 1: 1% traffic, 1 hour, ✅ PASS
34
+ - Stage 2: 10% traffic, 2 hours, ✅ PASS
35
+ - Stage 3: 50% traffic, 4 hours, ✅ PASS
36
+ - Stage 4: 100% traffic, 24+ hours, ✅ PASS
37
+
38
+ **Metrics**:
39
+ - Error Rate: 0.08% (target <1%) ✅
40
+ - Latency P95: 191ms (target <200ms) ✅
41
+ - Availability: 99.92%
42
+ - Issues: None
43
+ - Rollback: Not required
44
+
45
+ **Consumers Migrated**:
46
+ - WebApp: ✅ Updated (deployed v[X] with response parsing fix)
47
+ - Mobile: ✅ Already on v1.3+
48
+ - Dashboard: ✅ Updated
49
+ - Admin: ✅ Updated
50
+ - Partners: ⏳ In progress (2/3 clients migrated)
51
+
52
+ **Post-Deployment**:
53
+ - Monitoring window: 24 hours
54
+ - All checks: ✅ PASS
55
+ - Team stood down: 2026-06-01 18:00 UTC
56
+ - Previous version decommissioned: 2026-06-01 20:00 UTC
57
+
58
+ ---
59
+
60
+ ## v2.5.3 - May 15, 2026
61
+
62
+ **Status**: ✅ COMPLETE (patch release)
63
+ ...
64
+ ```
65
+
66
+ ---
67
+
68
+ ## release-metrics.csv Format
69
+
70
+ ```csv
71
+ date,version,strategy,risk_score,breaking_changes,affected_consumers,duration_hours,error_rate_pct,latency_p95_ms,issues_count,rollback_required,approval_chain,status
72
+ 2026-05-31,v3.0.0,canary,7,2,12,8.5,0.08,191,0,false,TL+PL,complete
73
+ 2026-05-15,v2.5.3,rolling,2,0,0,2.0,0.06,185,0,false,TL,complete
74
+ 2026-05-01,v2.5.2,rolling,1,0,0,1.5,0.07,187,0,false,auto,complete
75
+ 2026-04-15,v2.5.1,blue-green,3,1,3,3.0,0.09,192,1,false,TL+PL,complete
76
+ 2026-04-01,v2.5.0,canary,6,1,8,9.0,0.08,190,0,false,TL+PL+CTO,complete
77
+ ```
78
+
79
+ ---
80
+
81
+ ## Monthly Health Report Template
82
+
83
+ ```markdown
84
+ # Release Health Report - May 2026
85
+
86
+ ## Summary
87
+
88
+ | Metric | May 2026 | April 2026 | Trend |
89
+ |--------|----------|-----------|-------|
90
+ | Releases | 5 | 4 | ↑ 25% |
91
+ | Avg Risk Score | 3.8/10 | 4.2/10 | ↓ Improving |
92
+ | Avg Error Rate | 0.077% | 0.081% | ↓ Improving |
93
+ | Avg Latency P95 | 189ms | 194ms | ↓ Improving |
94
+ | Rollback Rate | 0% | 0% | = Stable |
95
+ | Avg Deploy Time | 3.5 hrs | 4.1 hrs | ↓ Faster |
96
+ | Consumer Migration Success | 99.5% | 97% | ↑ Improving |
97
+
98
+ ---
99
+
100
+ ## May Releases
101
+
102
+ ### v3.0.0 - May 31 (MAJOR)
103
+ - Strategy: Canary
104
+ - Duration: 8.5 hours
105
+ - Status: ✅ Success
106
+ - Issues: None
107
+
108
+ ### v2.5.3 - May 15 (PATCH)
109
+ - Strategy: Rolling
110
+ - Duration: 2 hours
111
+ - Status: ✅ Success
112
+ - Issues: None
113
+
114
+ ### v2.5.2 - May 1 (PATCH)
115
+ - Strategy: Rolling
116
+ - Duration: 1.5 hours
117
+ - Status: ✅ Success
118
+ - Issues: None (bug fix)
119
+
120
+ ---
121
+
122
+ ## Performance Trends
123
+
124
+ ### Deployment Duration (Hours)
125
+
126
+ ```
127
+ May 31: 8.5 (canary v3.0.0, complex)
128
+ May 15: 2.0 (rolling v2.5.3, simple)
129
+ May 1: 1.5 (rolling v2.5.2, simple)
130
+ Apr 15: 3.0 (blue-green v2.5.1, medium)
131
+ Apr 1: 9.0 (canary v2.5.0, complex)
132
+
133
+ Average: 4.8 hours → Targeting: 3.5 hours
134
+ ```
135
+
136
+ ### Error Rates (%)
137
+
138
+ ```
139
+ May avg: 0.077%
140
+ Apr avg: 0.081%
141
+ Mar avg: 0.095%
142
+
143
+ Trend: ↓ Improving (better automation, earlier detection)
144
+ Target: <0.05% by Q3 2026
145
+ ```
146
+
147
+ ### Rollback Rate (%)
148
+
149
+ ```
150
+ May: 0% (5/5 successful, no rollbacks)
151
+ Apr: 0% (4/4 successful, no rollbacks)
152
+ Mar: 20% (1/5 rolled back due to API format issue)
153
+
154
+ Trend: ↑ Improving (pre-deployment validation preventing failures)
155
+ ```
156
+
157
+ ---
158
+
159
+ ## Improvement Opportunities
160
+
161
+ 1. **Deployment Automation**: Canary stages could be automated further (currently manual decisions)
162
+ - Expected savings: 2+ hours per release
163
+ - Effort: Medium (auto-go criteria definition)
164
+
165
+ 2. **Consumer Migration**: Manual tracking of consumer updates
166
+ - Expected savings: 1 hour per breaking change release
167
+ - Effort: High (requires consumer API integration)
168
+
169
+ 3. **Database Migrations**: Currently manual (could auto-rollback if data inconsistency detected)
170
+ - Expected savings: 30 min per migration
171
+ - Effort: High (complex, risky)
172
+
173
+ ---
174
+
175
+ ## Queries & Analytics
176
+
177
+ ### Find all BREAKING releases in past 30 days
178
+ ```
179
+ SELECT * FROM release_metrics
180
+ WHERE date > DATE('2026-05-01')
181
+ AND breaking_changes > 0
182
+ ORDER BY date DESC;
183
+
184
+ Result: v3.0.0 (2 breaking), v2.5.1 (1 breaking)
185
+ ```
186
+
187
+ ### Find releases with longest deployment time
188
+ ```
189
+ SELECT date, version, strategy, duration_hours, risk_score
190
+ FROM release_metrics
191
+ ORDER BY duration_hours DESC
192
+ LIMIT 5;
193
+
194
+ Result:
195
+ - v2.5.0: 9.0 hours (canary, risk 6)
196
+ - v3.0.0: 8.5 hours (canary, risk 7)
197
+ - v2.5.1: 3.0 hours (blue-green, risk 3)
198
+ ```
199
+
200
+ ### Calculate average deployment time by strategy
201
+ ```
202
+ SELECT strategy, COUNT(*) as count, AVG(duration_hours) as avg_duration
203
+ FROM release_metrics
204
+ GROUP BY strategy
205
+ ORDER BY avg_duration DESC;
206
+
207
+ Result:
208
+ - Canary: avg 8.75 hours (2 releases)
209
+ - Blue-Green: avg 3.0 hours (1 release)
210
+ - Rolling: avg 1.67 hours (2 releases)
211
+ ```
212
+
213
+ ### Find releases with issues
214
+ ```
215
+ SELECT date, version, issues_count, rollback_required, status
216
+ FROM release_metrics
217
+ WHERE issues_count > 0 OR rollback_required = true;
218
+
219
+ Result: None in May 2026 (all clean)
220
+ ```
221
+
222
+ ---
223
+
224
+ ## Monthly Highlights
225
+
226
+ ✅ **Successes**:
227
+ - 5 releases completed without rollbacks
228
+ - v3.0.0 (major, breaking) deployed successfully with canary strategy
229
+ - 99.5% consumer migration success rate
230
+ - Error rates improving month-over-month
231
+
232
+ ⚠️ **Opportunities**:
233
+ - Reduce canary deployment time (currently 8+ hours for high-risk)
234
+ - Automate consumer migration tracking
235
+ - Enhance pre-deployment validation
236
+
237
+ 🎯 **Targets for June**:
238
+ - Reduce avg deployment time to 3 hours (vs 4.8 current)
239
+ - Maintain 0% rollback rate
240
+ - 100% consumer migration for breaking changes
241
+ - Implement auto-canary-stage-progression
242
+
243
+ ---
244
+
245
+ ## Archive Strategy
246
+
247
+ - **Recent** (< 3 months): Keep in RELEASE_LOG.md + release-metrics.csv
248
+ - **Aging** (3-12 months): Archive to release-metrics-2026-Q1.csv.gz
249
+ - **Archived** (> 12 months): Store in S3, reference in historical reports
250
+
251
+ Example:
252
+ - 2026 Q1: release-metrics-2026-Q1.csv.gz (archived May 2026)
253
+ - 2025 Q4: release-metrics-2025-Q4.csv.gz (archived Feb 2026)