feat: add evaluation evidence manifest#891
Conversation
|
Warning Review limit reached
More reviews will be available in 49 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR introduces a lightweight evidence manifest system for evaluation reports. A new Node.js CLI module validates JSON metadata files (stored alongside markdown reports) containing report identifiers, source information, fetch timestamps, liveness results, and JD hashes. The validation logic is documented, integrated into the npm script system, and included in pre-merge tests; pipeline modes are updated to specify where manifests should be saved. ChangesEvidence Manifest Validation and Integration
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@modes/auto-pipeline.md`:
- Around line 28-32: Clarify the liveness_result semantics: update the guidance
to state that evidence-manifest.mjs validation expects liveness_result =
"not_applicable" for local file sources (those whose original URL/value starts
with "local:") and liveness_result = "unverified" for non-local inputs where
liveness checking was skipped; reference the validation logic in
evidence-manifest.mjs (lines ~50-52) and the manifest filename pattern in
modes/auto-pipeline.md when making the wording change.
In `@modes/pipeline.md`:
- Around line 13-14: The pipeline docs currently list only a subset of manifest
fields; update modes/pipeline.md to enumerate all required manifest properties
as defined in the manifest schema (evidence-manifest.mjs) so generated manifests
are valid: include report_number, company, role, source, fetched_at in addition
to source_path, liveness_result, jd_hash, report_path and pdf_path/null; mirror
the field names and expected formats used in evidence-manifest.mjs and align
wording with modes/auto-pipeline.md to avoid divergence.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 64165706-58f8-49a8-84b8-b3157456babd
📒 Files selected for processing (6)
docs/SCRIPTS.mdevidence-manifest.mjsmodes/auto-pipeline.mdmodes/pipeline.mdpackage.jsontest-all.mjs
|
Fixed the valid CodeRabbit documentation feedback for evidence manifests. Changes:
Validation: |
|
Closing under the acceptance criterion explained in full on #890: core takes what the candidate uses; project-artifact tooling lives outside the core. For this one specifically: evidence manifests have no consumer in any current flow — schema-first artifacts should be designed against a real consumer when one exists. The companion-repo door from #890 applies to this one too. 🙏 |
Summary
evidence-manifest.mjsto validate lightweightreports/*.evidence.jsonfiles.Fixes #883
Tests
node --check evidence-manifest.mjs && node evidence-manifest.mjs --self-testnode evidence-manifest.mjsnode --check test-all.mjs && node test-all.mjs --quick— 167 passed, 0 failed, 7 existing README.ua personal-data warningsSummary by CodeRabbit
New Features
npm run evidence) to verify lightweight JSON metadata files stored alongside evaluation reports, ensuring required fields are present and data integrity is maintained.Documentation