docs(runbook): add relay PR evidence template and summary draft
This commit is contained in:
@@ -110,6 +110,31 @@ Recommended starting posture:
|
||||
3. Full rollback path: revert relay hardening commit set and redeploy.
|
||||
4. Record incident + mitigation outcome in `memory-bank/change-log.md` and `memory-bank/pitfalls.md`.
|
||||
|
||||
### PR Evidence Snapshot Template (copy into PR description)
|
||||
|
||||
Use this template when shipping relay policy updates:
|
||||
|
||||
```
|
||||
Relay policy smoke evidence (non-prod)
|
||||
|
||||
- [ ] 401/403 deterministic auth failures -> no retries observed
|
||||
- [ ] 400/404 deterministic validation failures -> no retries observed
|
||||
- [ ] 429/503 transient failures -> bounded retries/backoff observed
|
||||
- [ ] timeout path -> bounded failure path, no retry storm
|
||||
- [ ] structured redacted logs emitted (`relay_request_retrying` / `relay_request_failed`)
|
||||
- [ ] duplicate endpoint-layer error logging suppressed for already-logged relay failures
|
||||
|
||||
Runtime knobs used during validation:
|
||||
- RELAY_TIMEOUT_MS=
|
||||
- RELAY_RETRY_MAX=
|
||||
- RELAY_RETRY_BASE_DELAY_MS=
|
||||
- RELAY_RETRY_MAX_DELAY_MS=
|
||||
|
||||
Rollback readiness:
|
||||
- [ ] quick mitigation validated: RELAY_RETRY_MAX=0
|
||||
- [ ] commit-revert path identified and documented
|
||||
```
|
||||
|
||||
## Definition of Ready for AI-Assisted Tasks
|
||||
|
||||
- Clear acceptance criteria
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
# TASK22239 PR Summary Draft
|
||||
|
||||
## Scope summary
|
||||
|
||||
- Added relay-policy governance and rollout controls so timeout/retry/logging changes are treated as operationally sensitive changes.
|
||||
- Added a copy/paste PR evidence template for non-prod smoke outcomes, runtime knobs used, and rollback readiness.
|
||||
|
||||
## Files changed
|
||||
|
||||
- `context/runbook.md`
|
||||
- `context/integration-map.md`
|
||||
- `memory-bank/change-log.md` (CL-032)
|
||||
- `memory-bank/decisions.md` (D-003)
|
||||
- `memory-bank/patterns.md` (P-004)
|
||||
- `.gitignore` (context tracking enabled)
|
||||
|
||||
## Risk notes
|
||||
|
||||
- **Auth/Data:** no runtime auth or data-path behavior changes in this slice.
|
||||
- **i18n/a11y:** no user-facing route/content behavior changes.
|
||||
- **Operational:** process-only hardening; intended to reduce risk in future relay policy updates.
|
||||
|
||||
## Validation evidence
|
||||
|
||||
- Documentation consistency reviewed across:
|
||||
- `context/runbook.md`
|
||||
- `context/integration-map.md`
|
||||
- `memory-bank/change-log.md`
|
||||
- `memory-bank/decisions.md`
|
||||
- `memory-bank/patterns.md`
|
||||
|
||||
## Rollback plan
|
||||
|
||||
1. Revert commit(s) from `TASK22239-relay-governance-rollout`.
|
||||
2. If needed, restore previous `.gitignore` behavior for `context/` tracking.
|
||||
3. Confirm branch clean state and re-run PR checks.
|
||||
Reference in New Issue
Block a user