docs: publish recipe-health matrix (#1229)#1317
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR removes the temporary deferral mechanism for recipe health documentation. The Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
mchmarny
left a comment
There was a problem hiding this comment.
Clean docs + dead-code removal. Splices the generated matrix (32 recipes, all pass) over the AICR-HEALTH-DEFERRED sentinel and drops the now-dead skip guard from recipe-health-check, so the staleness check runs unconditionally — its intended end state.
Verified: row count (32) matches the Summary header, and the ADR-009 link survives in the unchanged intro prose (no orphaned reference from removing the deferral note). The Makefile target keeps set -e, the regen step, and the git diff --quiet staleness check intact. CI is green.
Non-blocking: mergeable_state is behind — rebase onto origin/main before merge. LGTM.
Summary
Publishes the previously-deferred recipe-health matrix into
docs/user/recipe-health.md— all 32 leaf recipes now gradepass.Motivation / Context
Issue #1229 shipped the
tools/healthgenerator, themake recipe-health-docs/recipe-health-checktargets, and the doc scaffolding, but withheld the committed matrix body behind anAICR-HEALTH-DEFERREDsentinel. The deferral reason was achart_pinnedfalse-positive: manifest-only Helm components (declaredtype: Helmbut shipping localmanifestFileswith no external chart, e.g.nodewright-customizations) were gradedfail, making 17/32 recipes falsely fail. That signal was corrected in #1303 ("exempt manifest-only Helm components from chart_pinned"), so the matrix is now accurate and safe to publish.Fixes: #1229
Related: #1303
Type of Change
Component(s) Affected
docs/,examples/)Makefile(recipe-health-check target)Implementation Notes
make recipe-health-docsto splice the generated matrix between theBEGIN/END AICR-HEALTHmarkers, replacing the sentinel and deferred-note prose. Result: 32 recipes, allpass(0 warn/fail/unknown).recipe-health-checktarget. With the matrix published, the staleness check runs unconditionally — its intended end state.Testing
Risk Assessment
Rollout notes: N/A —
recipe-health-checkis advisory and not wired intomake qualifyor the merge gate.Checklist
make testwith-race)make lint)git commit -S)