Repository navigation
docs(agents): add E2E and CI testing conventions - #2932
Conversation
Capture the e2e stabilization conventions established over the last few months as a routed agent doc: no retries on deterministic CI steps, event-driven backstops over fixed sleeps, no EXIT/RETURN traps, fail-fast HelmRelease-readiness gating, the status.history remediation guard, first-class failure diagnostics, and a reviewer checklist. Also documents Test-Impact Analysis (TIA) and its real scope — it trims only the per-app loop, runs after install, and most PRs escalate to the full suite. Wire it into AGENTS.md so every agent reads it before e2e/CI work. Assisted-By: Claude <[email protected]> Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> Signed-off-by: Myasnikov Daniil <[email protected]>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new documentation file to standardize end-to-end testing and CI practices within the Cozystack project. By formalizing conventions around test stability, cleanup, and failure reporting, the changes aim to reduce flaky tests and improve the overall reliability and diagnostic quality of the CI pipeline. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on Gemini (@gemini-code-assist) comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
dosubot
Bot
added
area/ai
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughAdds a new agent conventions document ChangesE2E Testing Conventions
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive guide on end-to-end (E2E) testing conventions (docs/agents/e2e-testing.md) and updates AGENTS.md to reference it. The new documentation outlines core principles (such as avoiding retries on deterministic steps to prevent hiding bugs), specific conventions for writing robust and deterministic E2E tests, a reviewer checklist, and future directions like migrating from BATS to Kyverno Chainsaw. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
github-actions
Bot
added
the
size/L
## What this PR does Promotes universal project guidance that previously lived only in a local (gitignored) `CLAUDE.md` into the committed agent docs, so every contributor and every tool (Codex/Cursor/etc., not just Claude) gets it from a fresh clone. - `overview.md`: Build & Development Commands (root + per-package make targets, build env vars), Values schema generation, a Testing section, Domain references - `contributing.md`: a "Verify Before Considering Done" matrix + Review Expectations - Dedup: `overview.md`'s Git Commits block now points to `contributing.md` > Note: `overview.md` links to `docs/agents/e2e-testing.md` added in #2932 — merge > that one first or together. ### Release note ```release-note NONE ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Expanded contribution guidance with a “Verify Before Considering Done” pre-submission checklist and clearer expectations for including behavioral regression tests in bug-fix PRs. * Broadened build/development documentation with a “Build and Development Commands” guide, including required environment variables, values-schema generation, and test entry points. * Updated contribution workflow notes by consolidating commit-convention guidance and adding pointers to task-specific design references. * Added a Claude entry-point document that directs to the main agents guide and explains local override placement. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
3 participants
What this PR does
Adds
docs/agents/e2e-testing.md— a routed agent doc capturing the e2e/CIstabilization conventions built up over the last few months:
Prepare environmentretries)sleep; noEXIT/RETURNtrapsstatus.historyremediation guardruns after install, and most PRs legitimately escalate to the full suite
Wired into
AGENTS.mdso every agent reads it before e2e/CI work.Release note
Summary by CodeRabbit