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.
- package/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -216
- package/.codebase/CURRENT_STATE.md +8 -2
- package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -161
- package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -613
- package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -429
- package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -351
- package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -419
- package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -292
- package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -486
- package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -456
- package/.codebase/README.md +139 -139
- package/.codebase/RECOVERY_POINTS.md +83 -438
- package/.codebase/beads.json +16 -0
- package/.codex/skills/genesis-ai-provider/SKILL.md +1 -1
- package/.codex/skills/genesis-api-contract/SKILL.md +1 -1
- package/.codex/skills/genesis-api-sync/SKILL.md +354 -354
- package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -101
- package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -257
- package/.codex/skills/genesis-architecture/SKILL.md +1 -1
- package/.codex/skills/genesis-codebase-map/SKILL.md +1 -1
- package/.codex/skills/genesis-debug-guide/SKILL.md +479 -479
- package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -339
- package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -210
- package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -158
- package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -365
- package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -289
- package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -288
- package/.codex/skills/genesis-design-spec/SKILL.md +3 -3
- package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -1003
- package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -359
- package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -312
- package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -382
- package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -851
- package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -491
- package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -187
- package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -297
- package/.codex/skills/genesis-harness/SKILL.md +1428 -1427
- package/.codex/skills/genesis-harness/agents/openai.yaml +7 -7
- package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -169
- package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -157
- package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -216
- package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -211
- package/.codex/skills/genesis-harness/references/planning-schema.md +35 -35
- package/.codex/skills/genesis-harness/references/quality-rubric.md +21 -21
- package/.codex/skills/genesis-harness/references/research-rubric.md +41 -41
- package/.codex/skills/genesis-harness/references/workflows.md +33 -33
- package/.codex/skills/genesis-harness/resources/agents-template.md +27 -27
- package/.codex/skills/genesis-harness/resources/api-docs-template.md +32 -32
- package/.codex/skills/genesis-harness/resources/architecture-template.md +30 -30
- package/.codex/skills/genesis-harness/resources/audit-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/bug-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -204
- package/.codex/skills/genesis-harness/resources/check-template.md +21 -21
- package/.codex/skills/genesis-harness/resources/conventions-template.md +42 -42
- package/.codex/skills/genesis-harness/resources/decision-template.md +33 -33
- package/.codex/skills/genesis-harness/resources/design-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/escalation-template.md +21 -21
- package/.codex/skills/genesis-harness/resources/feature-template.md +49 -49
- package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -131
- package/.codex/skills/genesis-harness/resources/integrations-template.md +32 -32
- package/.codex/skills/genesis-harness/resources/journeys-template.md +13 -13
- package/.codex/skills/genesis-harness/resources/lessons-learned-template.md +12 -12
- package/.codex/skills/genesis-harness/resources/observability-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -76
- package/.codex/skills/genesis-harness/resources/phase-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/pitfalls-template.md +22 -22
- package/.codex/skills/genesis-harness/resources/planning-tree-template.md +39 -39
- package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -347
- package/.codex/skills/genesis-harness/resources/project-template.md +38 -38
- package/.codex/skills/genesis-harness/resources/quality-score-template.md +11 -11
- package/.codex/skills/genesis-harness/resources/requirements-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/research-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/review-template.md +22 -22
- package/.codex/skills/genesis-harness/resources/spec-changelog-template.md +6 -6
- package/.codex/skills/genesis-harness/resources/stack-template.md +33 -33
- package/.codex/skills/genesis-harness/resources/verification-template.md +26 -26
- package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/compact-context.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-adr.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-bug.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-feature.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/detect-stack.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/init-planning.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/offload-log.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/run-verification.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/update-state.sh +0 -0
- package/.codex/skills/genesis-harness-engineering/SKILL.md +1 -1
- package/.codex/skills/genesis-new-design/SKILL.md +2 -1
- package/.codex/skills/genesis-new-design/agents/openai.yaml +3 -3
- package/.codex/skills/genesis-observability-automation/checklists/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/observability/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/playbooks/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/templates/.gitkeep +0 -0
- package/.codex/skills/genesis-pipeline-orchestration/SKILL.md +1 -1
- package/.codex/skills/genesis-planning/SKILL.md +26 -1
- package/.codex/skills/genesis-planning/checklists/mvp-readiness.md +18 -0
- package/.codex/skills/genesis-planning/examples/5-phase-roadmap-example.md +43 -0
- package/.codex/skills/genesis-planning/templates/phase-1-core.md +17 -0
- package/.codex/skills/genesis-planning/templates/phase-2-auth.md +17 -0
- package/.codex/skills/genesis-planning/templates/phase-3-features.md +17 -0
- package/.codex/skills/genesis-planning/templates/phase-4-integrations.md +17 -0
- package/.codex/skills/genesis-planning/templates/phase-5-readiness.md +17 -0
- package/.codex/skills/genesis-release/SKILL.md +24 -1
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/checklists/post-deployment-verification.md +274 -274
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/checklists/pre-release-validation.md +220 -220
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/observability/release-tracking.md +253 -253
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/playbooks/canary-deployment-orchestration.md +472 -472
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/playbooks/semantic-versioning-automation.md +494 -494
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/templates/deployment-strategy-template.md +303 -303
- package/.codex/skills/{genesis-release-orchestration → genesis-release}/templates/release-runbook-template.md +420 -420
- package/.codex/skills/genesis-research-first/SKILL.md +237 -237
- package/.codex/skills/genesis-research-first/templates/.gitkeep +0 -0
- package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -534
- package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -384
- package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -257
- package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -373
- package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -692
- package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -434
- package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -407
- package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/SKILL.md +1 -1
- package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +3 -3
- package/.codex/skills/spec-impact-engine/SKILL.md +504 -504
- package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +0 -0
- package/.codex-plugin/plugin.json +19 -19
- package/CHANGELOG.md +56 -0
- package/LICENSE +22 -22
- package/README.EN.md +780 -730
- package/README.VI.md +772 -723
- package/README.md +102 -247
- package/VERSION +2 -2
- package/bin/genesis-harness.js +695 -92
- package/package.json +9 -3
- package/scripts/README.md +342 -342
- package/scripts/compact-context.sh +0 -0
- package/scripts/contract_integrity_gate.js +83 -0
- package/scripts/detect-changes.sh +0 -0
- package/scripts/healing_telemetry.js +118 -0
- package/scripts/install.sh +5 -6
- package/scripts/offload-log.sh +0 -0
- package/scripts/prompt_sentinel.js +84 -0
- package/scripts/run-evals.sh +20 -24
- package/scripts/run-verify-loop.sh +11 -0
- package/scripts/spec_visual_sync.js +157 -0
- package/scripts/test_generator.js +142 -0
- package/scripts/transition_state.sh +0 -0
- package/scripts/uninstall.sh +2 -5
- package/scripts/validation_gates.sh +40 -1
- package/scripts/verify.sh +6 -61
- package/tests/unit/contract_integrity_gate.test.js +74 -0
- package/tests/unit/healing_telemetry.test.js +58 -0
- package/tests/unit/prompt_sentinel.test.js +50 -0
- package/tests/unit/spec_visual_sync.test.js +77 -0
- package/tests/unit/test_generator.test.js +62 -0
- package/.codex/skills/genesis-docs/SKILL.md +0 -46
- package/.codex/skills/genesis-docs/agents/openai.yaml +0 -7
- package/.codex/skills/genesis-release-orchestration/SKILL.md +0 -653
- package/.codex/skills/genesis-release-orchestration/agents/openai.yaml +0 -7
- package/.codex/skills/genesis-research/SKILL.md +0 -46
- package/.codex/skills/genesis-research/agents/openai.yaml +0 -7
- /package/.codex/skills/{genesis-docs/checklists/checklist.md → genesis-docs-automation/checklists/manual-docs-checklist.md} +0 -0
- /package/.codex/skills/{genesis-docs/examples/example.md → genesis-docs-automation/examples/manual-docs-example.md} +0 -0
- /package/.codex/skills/{genesis-docs → genesis-docs-automation}/templates/docs-update-template.md +0 -0
- /package/.codex/skills/{genesis-state-machine/SKILL.md → genesis-harness/references/state-machine.md} +0 -0
- /package/.codex/skills/{genesis-release-orchestration/examples/example.md → genesis-release/examples/orchestration-example.md} +0 -0
- /package/.codex/skills/{genesis-research → genesis-research-first}/checklists/checklist.md +0 -0
- /package/.codex/skills/{genesis-research/examples/example.md → genesis-research-first/examples/manual-research-example.md} +0 -0
- /package/.codex/skills/{genesis-research → genesis-research-first}/templates/research-note-template.md +0 -0
- /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/agents/openai.yaml +0 -0
- /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/checklists/checklist.md +0 -0
- /package/.codex/skills/{ui-ux-test-skill → genesis-ui-ux-test}/examples/example.md +0 -0
- /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)
|