docs(governance): track context docs and add relay rollout controls

This commit is contained in:
2026-03-24 12:26:32 +00:00
parent 2ac2f51fc3
commit ad0d2bf285
11 changed files with 847 additions and 1 deletions
+33
View File
@@ -1189,3 +1189,36 @@ Validation:
Follow-ups:
- Batch 2B: update memory/context docs with canonical relay hardening policy, env knobs, and rollback/tuning guidance.
---
### CL-032: TASK22239 governance + operational rollout playbook bundle (relay hardening)
date: 2026-03-24
author: Cline
scope: `context/runbook.md`, `context/integration-map.md`, `memory-bank/{change-log,decisions,patterns}.md`
type: change
rationale: Deliver a combined governance and operational rollout slice after P2-S3 code hardening so relay policy changes have explicit merge gates, smoke matrix coverage, and rollback/monitoring discipline.
impact: Improves release safety and auditability for relay policy updates without changing runtime endpoint behavior.
status: completed
Summary:
- Added a dedicated **Relay Hardening Rollout Playbook** section to `context/runbook.md` covering:
- pre-merge governance gate checklist
- non-prod smoke matrix for deterministic and transient failure classes
- progressive rollout guidance
- Day 1/Day 3 monitoring checks
- fast mitigation/rollback sequence
- Added relay policy governance references in architecture/integration context docs to make rollout checks discoverable for future contributors.
- Recorded governance baseline updates in memory-bank:
- decision entry for relay policy-change governance gate
- reusable pattern entry for required rollout/smoke/rollback workflow
Validation:
- Documentation consistency review across `context/runbook.md`, `context/integration-map.md`, and memory-bank entries.
Follow-ups:
- Optional next iteration: add a PR template block in Azure DevOps mirroring the runbook governance gate checklist.
+32
View File
@@ -80,3 +80,35 @@ Related:
- `memory-bank/change-log.md` (CL-030, CL-031)
- `tests/phase21/relay-forwarding-hardening.test.cjs`
---
### D-003: Relay policy changes require governance gate + rollout evidence
date: 2026-03-24
author: Cline
scope: relay policy changes (`pages/api/middleware/relayForwarding.js`) and related rollout docs
type: decision
rationale: Prevent regression risk from reliability-policy changes by requiring explicit pre-merge controls and operational smoke evidence.
impact: Improves production safety and auditability for relay behavior changes without altering endpoint API contracts.
status: accepted
Decision:
- Any relay policy change (timeout/retry/logging classification) must include:
- explicit PR governance checklist completion
- non-prod smoke matrix evidence for deterministic + transient classes
- rollback path and monitoring checks
- Policy and rollout guidance source-of-truth is maintained in:
- `context/runbook.md` Relay Hardening Rollout Playbook
- memory-bank change/decsion/pattern entries for traceability
Consequences:
- Relay hardening changes are treated as operationally sensitive even when endpoint contracts do not change.
- Future contributors have a repeatable gate for shipping policy changes safely.
Related:
- `context/runbook.md`
- `memory-bank/change-log.md` (CL-032)
+24
View File
@@ -89,3 +89,27 @@ Example paths:
- `pages/api/endpoint/getadvancedsearch_api.js`
- `pages/api/endpoint/getdnscoords_api.js`
- `tests/phase21/relay-forwarding-hardening.test.cjs`
### P-004: Relay Policy Change Bundle (Governance + Smoke + Rollback)
date: 2026-03-24
author: Cline
scope: relay policy changes + rollout documentation
type: pattern
rationale: Relay reliability changes can alter runtime behavior without changing endpoint contracts; bundle process controls and operational checks together to reduce regression risk.
impact: Improves release confidence and standardizes operational readiness for relay policy updates.
status: accepted
Pattern:
For relay timeout/retry/logging policy updates, ship one documentation bundle that includes governance checklist, non-prod smoke matrix, monitoring checks, and rollback instructions.
When to use:
- Any change to retry classification, timeout defaults/bounds, or relay logging behavior
- Any change to relay environment tuning guidance
Example paths:
- `context/runbook.md`
- `memory-bank/change-log.md`
- `memory-bank/decisions.md`