docs: document rule data defaults guidance - #1825
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughAGENTS.md now documents ChangesRule-data guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change does not alter product behavior, and no actionable merge-blocking risk remains after normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation The description explains the change, its purpose, linked issue, validation, and documentation-only scope. It uses Summary and Testing headings instead of the template's What and Why headings, but the required information is present. Full details: Linked Issues checkExplanation The changes address issue Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🤖 Finished Review · ✅ Success · Started 5:32 AM UTC · Completed 5:45 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.39 |
ReviewFindingsMedium
|
Summary\n\n- Document the four-tier
ule_data.get() resolution order and replacement semantics.\n- Define criteria for values in the hardcoded defaults map.\n- Add a review checklist item and link to the data-source configuration docs.\n\nFixes #1824\n\n## Testing\n\n- git diff --check passed.\n- Documentation assertions for the requested hierarchy, fallback, defaults guidance, link, and checklist passed.\n- go run github.com/conforma/cli opa check ./example/data/rule_data.yml ./policy checks --strict passed.\n- opa fmt --list --fail reports the pre-existing .regal/rules/custom/prefer_parsed_blob.rego formatting issue.\n- Regal reports the pre-existing policy/lib/oci/oci.rego:10 prefer-parsed-blob violation.\n\nThis is a documentation-only change; no Rego behavior or generated docs were changed.