Skip to content

chore(ci): exclude NVSkills-generated files from trailing-whitespace hook #1465

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.

Sign up for GitHub

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
rapids-bot merged 3 commits into from
Jun 25, 2026
Merged

chore(ci): exclude NVSkills-generated files from trailing-whitespace hook #1465

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bfc3faf
chore(ci): exclude skill-card.md from trailing-whitespace hook
ramakrishnap-nv Jun 25, 2026
ff7d038
chore(ci): exclude NVSkills-generated files from trailing-whitespace …
ramakrishnap-nv Jun 25, 2026
626ec5a
chore(ci): exclude NVSkills-generated files at top-level pre-commit e…
ramakrishnap-nv Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ repos:
- id: end-of-file-fixer
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$

@jameslamb jameslamb Jun 25, 2026

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.

Why do this? Can't the process that modifies these files be modified to also not have any trailing whitespace?

@ramakrishnap-nv ramakrishnap-nv Jun 25, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

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.

@bdice bdice Jun 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Suggested change
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$
)

@jameslamb jameslamb Jun 25, 2026 •
edited
Loading

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.

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.

@ramakrishnap-nv ramakrishnap-nv Jun 25, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Pushed an update

@ramakrishnap-nv ramakrishnap-nv Jun 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

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.

@ramakrishnap-nv ramakrishnap-nv Jun 25, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

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.

- id: check-builtin-literals
- id: check-executables-have-shebangs
- id: check-json
Expand Down