chore(ci): exclude NVSkills-generated files from trailing-whitespace hook#1465
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
NVSkills-Eval regenerates skill-card.md with trailing whitespace after SKILL.md changes; exclude it alongside skill.oms.sig. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
3388c67 to
bfc3faf
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe pre-commit config adds a top-level exclude block for several ChangesPre-commit skill file exclusions
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/merge |
| exclude: ^(datasets|helmchart)/.*\.(mps|json|yaml|yml|txt)$|^skills/.*/skill\.oms\.sig$ | ||
| - id: trailing-whitespace | ||
| exclude: ^datasets/.*\.(mps|json|yaml|yml|txt)$|^skills/.*/skill\.oms\.sig$ | ||
| exclude: ^datasets/.*\.(mps|json|yaml|yml|txt)$|^skills/.*/skill\.oms\.sig$|^skills/.*/skill-card\.md$|^skills/.*/BENCHMARK\.md$ |
There was a problem hiding this comment.
Why do this? Can't the process that modifies these files be modified to also not have any trailing whitespace?
There was a problem hiding this comment.
This is generated or added by internal CI projects and it is controlled by nvcarps-team. So, it would take time to push them to update this.
There was a problem hiding this comment.
Agree with James's question. Also I recommend breaking this up for readability. See example: https://github.com/rapidsai/cudf/blob/69dc0799906273230297f18c5f5aa980bee23935/.pre-commit-config.yaml#L66-L71
| exclude: ^datasets/.*\.(mps|json|yaml|yml|txt)$|^skills/.*/skill\.oms\.sig$|^skills/.*/skill-card\.md$|^skills/.*/BENCHMARK\.md$ | |
| exclude: | | |
| (?x)^( | |
| ^datasets/.*\.(mps|json|yaml|yml|txt)$| | |
| ^skills/.*/skill\.oms\.sig$| | |
| ^skills/.*/skill-card\.md$| | |
| ^skills/.*/BENCHMARK\.md$ | |
| ) |
There was a problem hiding this comment.
In our offline discussion, @ramakrishnap-nv said this has to be excluded because some internal process produces it alongside a signature (content-based checksum), and we don't have much control over that process.
If that's the case, that these files should never be modified, then they should be added to the top-level exclude: in this file, not just this one specific hook.
There was a problem hiding this comment.
Pushed an update
There was a problem hiding this comment.
Update: Agree regarding the exclusion, I have updated it, @jameslamb for viz
Ignore:
Top-level exclude: would skip these files from all hooks including validate-skills and verify-copyright, which we do want to run on SKILL.md changes (and the generated files alongside it). Hook-level exclusion keeps the other checks active. Applied @bdice's formatting suggestion.
There was a problem hiding this comment.
Updated — moved all three NVSkills-generated files (skill.oms.sig, skill-card.md, BENCHMARK.md) to the top-level exclude: and removed the per-hook patterns.
jameslamb
left a comment
There was a problem hiding this comment.
Left a question, this PR is confusing to me.
…hook NVSkills-Eval regenerates skill-card.md and BENCHMARK.md with trailing whitespace after SKILL.md changes; exclude them alongside skill.oms.sig. Use verbose (?x) regex format for readability. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
…xclude skill.oms.sig, skill-card.md, and BENCHMARK.md are produced by an internal NVSkills-Eval service alongside a content-based signature; exclude them from all hooks at the top level rather than per-hook. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
| skills/.*/skill\.oms\.sig| | ||
| skills/.*/skill-card\.md| | ||
| skills/.*/BENCHMARK\.md | ||
| )$ |
There was a problem hiding this comment.
Should this be skills/.*? Wouldn't SKILL.md (for example) changing also change the signature?
There was a problem hiding this comment.
Yes, in that case we need to run CI which would generate new files and signature associated with it and push as commit, for reference #1460 (comment)
There was a problem hiding this comment.
But we want to follow guidelines on all other things that we write and control like SKILL.md or any other underlying references, only want to skip which are generated.
jameslamb
left a comment
There was a problem hiding this comment.
Going to say unhelpfully that this seems annoying to have to manage, but the changes are fine based on my understanding of how the process is working. Thanks for answering my questions.
NVSkills-Eval regenerates
skill-card.mdandBENCHMARK.mdwith trailing whitespace afterSKILL.mdchanges; exclude them alongsideskill.oms.sig.\n\nRelated: #1464