Skip to content

fix(hipdnn): keep the ingestor-engine runbook link inside the skill - #14618

Merged
GarbyGilbertAMD merged 1 commit into
developfrom
users/ggilbert/ALMIOPEN-2876/fix-runbook-link
Oct 28, 2026
Merged

GarbyGilbertAMD merged 1 commit into
developfrom
users/ggilbert/ALMIOPEN-2876/fix-runbook-link

Conversation

@GarbyGilbertAMD

Copy link
Copy Markdown
Contributor

Summary

#14463 added a link from the hipdnn-ingestor-engine runbook to projects/hipdnn/docs/Environment.md through ../../../../docs/, a path that leaves the skill directory. Installing a skill copies only that directory, so the link dangles in every installed copy, and validate-skills.py rejects it: on develop the validator exits 1 and test_committed_skills_validate_clean fails. No CI job runs either check. This PR names the same section as a repository path, the form the runbook already uses for other hipDNN documents.

JIRA ID : ALMIOPEN-2876

Risk Assessment

Risk 1. One line of Markdown in a skill runbook; no code, build, test or packaging change.

Testing Summary

  • test_committed_skills_validate_clean fails on develop with link target '../../../../docs/Environment.md#hipdnn_force_benchmarking' escapes the installed skill root 'hipdnn-ingestor-engine/' and passes with this change.
  • The validator also checks that a backticked projects/... path exists, so the new reference is checked.

Testing Checklist

  • Skill validation - python projects/hipdnn/tools/ai/validate-skills.py - Status: Passed (16 skills)
  • Skill tooling tests - pytest projects/hipdnn/tools/ai/tests/test_skills_tooling.py - Status: Passed (32)
  • Pre-commit hooks - on the changed file - Status: Passed
  • PR CI - GitHub PR checks - Status: Pending

Technical Changes

  • projects/hipdnn/tools/ai/skills/hipdnn-ingestor-engine/RUNBOOK.md (stage 6, Catalog size): the Markdown link to Environment.md#hipdnn_force_benchmarking becomes HIPDNN_FORCE_BENCHMARKING in projects/hipdnn/docs/Environment.md.

The hipdnn-ingestor-engine runbook linked to the hipDNN environment documentation with a relative path that leaves the skill directory. Installing a skill copies only its own directory, so the link dangled in every installed copy, and validate-skills.py rejected it. The reference now names HIPDNN_FORCE_BENCHMARKING in projects/hipdnn/docs/Environment.md as a repository path, the form the runbook already uses for other hipDNN documents.

ALMIOPEN-2876
@GarbyGilbertAMD
GarbyGilbertAMD marked this pull request as ready for review October 28, 2026 21:43
@GarbyGilbertAMD
GarbyGilbertAMD requested a review from a team as a code owner October 28, 2026 21:43
@therock-pr-bot

therock-pr-bot Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

✅ All Checks Passed — Ready for Review

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🔎 pre-commit ✅ Pass —
🚫 Draft PR 🔜 To Be Enabled —
🚩 Feature Flag 🔜 To Be Enabled —
📊 Code Coverage 🔜 To Be Enabled —
🤖 therock-pr-bot ✅ Pass —

🎉 All checks passed! This PR is ready for review.

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

@therock-pr-bot

Copy link
Copy Markdown

🎉 All checks passed! This PR is ready for review.

@GarbyGilbertAMD
GarbyGilbertAMD merged commit 6bbeceb into develop Oct 28, 2026
38 of 39 checks passed
@GarbyGilbertAMD
GarbyGilbertAMD deleted the users/ggilbert/ALMIOPEN-2876/fix-runbook-link branch October 28, 2026 21:49
@assistant-librarian

Copy link
Copy Markdown
Contributor

TheRock Submodule Bump Activity

Newest first

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.

2 participants