Skip to content

docs: publish recipe-health matrix (#1229)#1317

Merged
njhensley merged 4 commits into
NVIDIA:mainfrom
njhensley:docs/gen-recipe-health-matrix
Jun 11, 2026
Merged

docs: publish recipe-health matrix (#1229)#1317
njhensley merged 4 commits into
NVIDIA:mainfrom
njhensley:docs/gen-recipe-health-matrix

Conversation

@njhensley

Copy link
Copy Markdown
Member

Summary

Publishes the previously-deferred recipe-health matrix into docs/user/recipe-health.md — all 32 leaf recipes now grade pass.

Motivation / Context

Issue #1229 shipped the tools/health generator, the make recipe-health-docs / recipe-health-check targets, and the doc scaffolding, but withheld the committed matrix body behind an AICR-HEALTH-DEFERRED sentinel. The deferral reason was a chart_pinned false-positive: manifest-only Helm components (declared type: Helm but shipping local manifestFiles with no external chart, e.g. nodewright-customizations) were graded fail, 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

  • Documentation update
  • Build/CI/tooling

Component(s) Affected

  • Docs/examples (docs/, examples/)
  • Other: Makefile (recipe-health-check target)

Implementation Notes

  • Ran make recipe-health-docs to splice the generated matrix between the BEGIN/END AICR-HEALTH markers, replacing the sentinel and deferred-note prose. Result: 32 recipes, all pass (0 warn/fail/unknown).
  • Removed the now-dead sentinel-skip guard from the recipe-health-check target. With the matrix published, the staleness check runs unconditionally — its intended end state.
  • No Go source changed; the generator/targets/doc registration (docs/index.yml, component-catalog cross-link, CODEOWNERS) all landed in the original tools/health generator + make targets + public recipe-health matrix #1229 PR.

Testing

make recipe-health-docs   # idempotent: second regen byte-identical
make recipe-health-check  # passes against the committed doc
go test ./tools/health/...  # ok (golden + budget-timing gate)

Risk Assessment

  • Low — Doc regen + dead-code removal in an advisory make target; easy to revert.

Rollout notes: N/A — recipe-health-check is advisory and not wired into make qualify or the merge gate.

Checklist

  • Tests pass locally (make test with -race)
  • Linter passes (make lint)
  • I did not skip/disable tests to make CI green
  • I added/updated tests for new functionality
  • I updated docs if user-facing behavior changed
  • Changes follow existing patterns in the codebase
  • Commits are cryptographically signed (git commit -S)

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: c52feb17-90ef-4253-9a7c-924a539efaa1

📥 Commits

Reviewing files that changed from the base of the PR and between 2abca1e and 372be5a.

📒 Files selected for processing (1)
  • Makefile

📝 Walkthrough

Walkthrough

This PR removes the temporary deferral mechanism for recipe health documentation. The Makefile target recipe-health-check no longer exits early when <!-- AICR-HEALTH-DEFERRED --> is present; it always runs make recipe-health-docs and fails if the regenerated $(HEALTH_DOC_PATH) differs from the committed file. The docs file docs/user/recipe-health.md replaces the deferred sentinel block with the generated recipe health summary and a complete recipes table (Status, Coverage, Evidence).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

Possibly related PRs

  • NVIDIA/aicr#1304: Introduced the health generator and the recipe-health-docs/recipe-health-check flow that this PR modifies.

Suggested labels

area/ci, theme/ci-dx

Suggested reviewers

  • mchmarny
  • lockwobr
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: publish recipe-health matrix (#1229)' clearly and concisely summarizes the main change: publishing the previously-deferred recipe-health matrix to the documentation.
Description check ✅ Passed The description comprehensively explains the PR's purpose, motivation, changes made, testing performed, and risk assessment, all directly related to publishing the recipe-health matrix.
Linked Issues check ✅ Passed The PR fully implements the objectives from issue #1229: the recipe-health matrix is published with generated content, Makefile recipe-health-check sentinel guard is removed, and the make recipe-health-docs target works as specified.
Out of Scope Changes check ✅ Passed All changes are directly in scope: only the Makefile recipe-health-check target and docs/user/recipe-health.md documentation file were modified, with no extraneous changes to unrelated areas.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@njhensley njhensley enabled auto-merge (squash) June 11, 2026 18:06
@github-actions github-actions Bot removed the area/ci label Jun 11, 2026

@mchmarny mchmarny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@njhensley njhensley merged commit e05a236 into NVIDIA:main Jun 11, 2026
35 of 50 checks passed
@njhensley njhensley deleted the docs/gen-recipe-health-matrix branch June 23, 2026 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

tools/health generator + make targets + public recipe-health matrix

2 participants