-
Notifications
You must be signed in to change notification settings - Fork 72
feat(recipe-health): deep-link Evidence to dashboard + link-check bot #1809
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
njhensley
merged 1 commit into
NVIDIA:main
from
njhensley:feat/recipe-health-evidence-deeplink
Jul 20, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # Weekly link-integrity check for the recipe-health Evidence deep-links | ||
| # (RQ2 / #1284). | ||
| # | ||
| # Structurally a clone of bom-refresh.yaml (weekly schedule + workflow_dispatch, | ||
| # read-only GITHUB_TOKEN, ubuntu-latest, timeout-minutes) with one deliberate | ||
| # divergence: it never opens a PR and never edits a doc. Instead it runs | ||
| # tools/testgrid-link-check, which reads the committed dashboard presence | ||
| # manifest (pkg/testgrid/presence.yaml — the coordinates RQ1 deep-links) and | ||
| # fetches the live dashboard data with a bounded, origin-pinned HTTP client | ||
| # (off-origin redirects refused), then emits a Markdown report to | ||
| # $GITHUB_STEP_SUMMARY. A linked coordinate the live dashboard no longer serves | ||
| # is reported as a dead-link warning; a coordinate not yet linked is expected | ||
| # and not a warning. | ||
| # | ||
| # Advisory only, mirroring the warning-only recipe-evidence gate: it never | ||
| # blocks a merge (the job exits 0 even when warnings exist). Coordinate | ||
| # resolution against the live SPA is necessarily separate from lychee, which | ||
| # runs --offline and excludes design/ (fern-docs-ci.yaml) and so resolves no | ||
| # dynamic URLs at all — this is the right home, not a lychee tweak. | ||
|
|
||
| name: TestGrid Link Check | ||
|
|
||
| on: | ||
| schedule: | ||
| # Mondays 07:00 UTC, offset from bom-refresh (06:00) and recipe-health-refresh | ||
| # (06:30) so the three weekly jobs do not contend for runners at the same minute. | ||
| - cron: "0 7 * * 1" | ||
| workflow_dispatch: {} | ||
|
|
||
| # Serialize runs so a manual workflow_dispatch cannot race a scheduled run. | ||
| concurrency: | ||
| group: ${{ github.workflow }} | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| check: | ||
| name: Verify recipe-health Evidence deep-links against the live dashboard | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - name: Checkout Code | ||
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - name: Load versions | ||
| id: versions | ||
| uses: ./.github/actions/load-versions | ||
|
|
||
| - name: Set up Go | ||
| uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0 | ||
| with: | ||
| go-version: ${{ steps.versions.outputs.go }} | ||
| cache: false | ||
|
|
||
| # No Helm setup: this job only reads an embedded manifest and fetches one | ||
| # JSON document — it templates no chart and touches no cluster. | ||
|
|
||
| - name: Check Evidence deep-links and write report to step summary | ||
| env: | ||
| GOFLAGS: -mod=vendor | ||
| # The tool exits 0 even when it finds dead links (warning-only), so the | ||
| # job never fails the weekly run; the report is the signal. | ||
| run: | | ||
| go run ./tools/testgrid-link-check -report-out "$GITHUB_STEP_SUMMARY" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| // Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // Package testgrid maps a recipe's canonical coordinate to the AICR evidence | ||
| // dashboard (validation.aicr.run) and answers "does this coordinate have a | ||
| // dashboard presence?" — the two facts RQ1 (#1283) and RQ2 (#1284) share. | ||
| // | ||
| // It is deliberately thin and owns no mapping of its own: the recipe → | ||
| // coordinate mapping is pkg/recipe.CoordinateFor (the single shared function | ||
| // consumed by GP4/GP5/TG2/RQ1). testgrid only adds the dashboard host, the | ||
| // hash-routed deep-link scheme built around Coordinate.Path, and the committed | ||
| // presence manifest. | ||
| // | ||
| // Two presence sources, one spelling of a coordinate path: | ||
| // | ||
| // - Committed (hermetic): presence.yaml, embedded here and read offline by | ||
| // the recipe-health generator so link *construction* never touches the | ||
| // network. LoadPresence exposes it as a Presence set. | ||
| // - Live: the published data/index.json the dashboard renderer boots from. | ||
| // LivePaths extracts the present coordinate paths from a parsed index so | ||
| // the warning-only link-check bot can compare the committed links against | ||
| // what the dashboard actually serves. | ||
| package testgrid |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # Dashboard presence manifest (RQ1 / #1283). | ||
| # | ||
| # The committed set of TestGrid/validation.aicr.run coordinate paths that | ||
| # currently carry at least one real presence on the evidence dashboard. The | ||
| # recipe-health generator (tools/health) reads this list to decide which | ||
| # Evidence cells become a deterministic deep-link into the dashboard and which | ||
| # stay an honest `pending` — it stays hermetic (no network) because presence is | ||
| # read from this committed file, never fetched. | ||
| # | ||
| # Each entry is a "<group>/<dashboard>/<tab>" coordinate path, exactly as | ||
| # pkg/recipe.CoordinateFor(criteria).Path() renders it: group=service, | ||
| # dashboard=<accelerator>-<os>, tab=<intent>[-<platform>]. | ||
| # | ||
| # Today the dashboard only covers the UAT-driven recipes; most recipes stay | ||
| # `pending` until real-hardware coverage broadens. This file is the single | ||
| # source of truth for "linked" — the weekly, warning-only testgrid-link-check | ||
| # bot (RQ2 / #1284) fetches the live dashboard data and warns when an entry | ||
| # here no longer resolves, keeping the manifest honest without blocking merges. | ||
| # | ||
| # To add a coordinate: confirm https://validation.aicr.run/#/<path> shows real | ||
| # data, then add the path below (keep the list sorted), then run | ||
| # `make recipe-health-docs` and commit the regenerated | ||
| # docs/user/recipe-health.md in the same PR — the Evidence link only lands once | ||
| # the committed matrix is regenerated (recipe-health-check is advisory, not in | ||
| # the merge gate, so a presence-only edit would otherwise leave the doc stale | ||
| # until the weekly refresh PR picks it up). | ||
| coordinates: | ||
| - aks/h100-ubuntu/inference-dynamo | ||
| - aks/h100-ubuntu/training-kubeflow | ||
| - eks/h100-ubuntu/inference-dynamo | ||
| - eks/h100-ubuntu/training-kubeflow | ||
| - gke/h100-cos/inference-dynamo | ||
| - gke/h100-cos/training-kubeflow | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.