Skip to content

docs: add Chainsaw stable-state assertion convention to AGENTS.md #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SebTardif merged 1 commit into from
May 27, 2026
Merged

docs: add Chainsaw stable-state assertion convention to AGENTS.md #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,13 @@ directory. When referencing files elsewhere in the repo (e.g., `charts/`,
node. Keep CPU requests at or below 300m per test pod.
- E2E wait helpers (`waitForDeploymentReady`, `waitForResize`, etc.) must
log diagnostic state on timeout (pod phase, container state, events).
Silent timeouts make CI failures undiagnosable. See issue #84.
Silent timeouts make CI failures undiagnosable.
- Chainsaw assertions must target **stable** operator states, not transient
ones. With `minimumDataPoints: 1`, the operator can transition from
`InsufficientData` to `Monitoring` within seconds. A static assert on
the transient state races with the reconcile loop and intermittently
times out. Use script-based assertions that accept multiple valid states
when the assertion target can change during the poll window.
- When an E2E test fails intermittently in the nightly K8s version matrix,
check the failure pattern across multiple runs before blaming a specific
version. If the failure rotates randomly across versions, the root cause
Expand Down
Loading