docs(agents): sync local CI guidance#5960
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation-only PR updating Eggjs contribution and testing guidance: Node.js version bumped to 22.18.0, CI validation workflow reordered to lint → clean-tree tests → conditional build, and new troubleshooting for duplicate proto errors caused by stale dist/ artifacts. Changes span copilot instructions, tegg docs, and a new local CI guide. ChangesLocal CI Validation Workflow Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
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 updates the repository's documentation—including Copilot instructions, CLAUDE.md, and wiki pages—to guide developers to run unit tests from clean sources rather than immediately after a build. This prevents stale build artifacts in dist/ directories from causing duplicate proto errors during tegg test execution. It also updates the required Node.js and pnpm versions. The review feedback correctly points out a typo in two files where ut run ci was referenced instead of pnpm run ci, offering clear, actionable code suggestions to resolve the issue.
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.
Deploying egg with
|
| Latest commit: |
4331daa
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://807872f2.egg-cci.pages.dev |
| Branch Preview URL: | https://agent-egg-doc-ef7e2d11.egg-cci.pages.dev |
There was a problem hiding this comment.
Pull request overview
This PR syncs contributor/agent-facing documentation around “local CI” to match the canonical guidance in AGENTS.md, and records that guidance durably in the repo wiki—especially the requirement to run unit tests from clean sources to avoid tegg duplicate proto failures caused by stale build artifacts.
Changes:
- Added a new wiki workflow page documenting Local CI expectations and stale
dist/artifact cleanup for tegg. - Linked the new workflow page from the wiki index and recorded the update in the wiki log.
- Updated agent instructions (
.github/copilot-instructions.mdandtegg/CLAUDE.md) to reflect current Node/pnpm requirements and the fact that CI tests run without building first.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| wiki/workflows/local-ci.md | New workflow page documenting Local CI parity with GitHub Actions and stale dist/ cleanup for tegg. |
| wiki/log.md | Adds a dated log entry recording the new Local CI workflow documentation. |
| wiki/index.md | Links the new Local CI workflow page from the Workflows section. |
| tegg/CLAUDE.md | Adds tegg-specific guidance about avoiding builds immediately before tests and handling duplicate proto via cleanup. |
| .github/copilot-instructions.md | Updates Node/pnpm version guidance and clarifies that CI tests run without a preceding build; adjusts local validation sequencing accordingly. |
Deploying egg-v3 with
|
| Latest commit: |
4331daa
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://feaa2303.egg-v3.pages.dev |
| Branch Preview URL: | https://agent-egg-doc-ef7e2d11.egg-v3.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/copilot-instructions.md:
- Around line 28-29: Change the inconsistent wording that marks linting as
optional: update the “Run linting (optional but recommended) - takes ~2 seconds”
line to state linting is required and use the canonical instruction "Run pnpm
run lint to check code quality across all packages." Then make the same wording
consistent with the validation steps around the later section (the block that
currently describes required validation) so both places use the required
phrasing and the exact command "pnpm run lint".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 52b399f7-0efa-48fa-ad0c-13a90d19952a
📒 Files selected for processing (5)
.github/copilot-instructions.mdtegg/CLAUDE.mdwiki/index.mdwiki/log.mdwiki/workflows/local-ci.md
Summary
AGENTS.mdLocal CI guidance: Node/pnpm versions,pnpm run cimeaning, and avoiding builds immediately before unit tests.duplicate protofailures after local builds.Validation
pnpm run fmtcheckpassed.git diff --checkpassed.oxlint --type-aware --fixfails on a markdown-only staged set withNo files found to lint; full repo formatting passed before commit.Summary by CodeRabbit