pixi: add root clean task for stale build artifacts - #2443
Draft
rparolin wants to merge 1 commit into
Draft
Conversation
Moving a checkout between the cu12 and cu13 pixi environments leaves compiled Cython extensions, generated .pyx/.cpp sources, and the cache_driver/cache_runtime/cache_nvrtc parser caches from the previous CUDA major behind. The next build then fails with errors that point at code which is fine, and the fix -- knowing which of the many ignored paths to delete -- is folklore. Add `toolshed/clean.py` plus two tasks: pixi run clean-dry-run # list what would be removed pixi run clean # remove it The artifact list comes from `git status --ignored` rather than a hand-maintained glob list, so tracked files are never at risk -- notably the handful of *.cpp files that are checked in despite the blanket *.cpp ignore rule (param_packer.cpp, loader.cpp, *_impl.cpp). Deletion is then restricted by an allowlist of repository-owned paths, so an unrecognized ignored directory is preserved rather than removed just for being ignored. `.pixi` and hand-made virtualenvs are protected at any depth: they are expensive or developer-local, and never the cause of a stale-artifact build failure. An earlier attempt used `git clean -Xdf` with `:(exclude)` pathspecs instead of a script. That was dropped: on git 2.43 the presence of an exclude pathspec changes matching for the positive pathspecs too, so the command silently removed paths outside the directories it was given. Verified with a dry run on a dirty worktree (212 paths, 698 MiB) and unit checks of the path-classification rules. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
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. |
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Moving a checkout between the
cu12andcu13pixi environments leaves compiled Cython extensions, generated.pyx/.cppsources, and thecache_driver/cache_runtime/cache_nvrtcparser caches from the previous CUDA major behind. The next build then fails with errors that point at code which is perfectly fine, and the fix — knowing which of the many ignored paths to delete — is folklore.Adds
toolshed/clean.pyplus two tasks:Design
The artifact list comes from
git status --ignored, not a hand-maintained glob list. Anything git reports as ignored is by definition generated, so tracked files are never at risk — notably the handful of*.cppfiles that are checked in despite the blanket*.cppignore rule (param_packer.cpp,loader.cpp,*_impl.cpp). Keeping a parallel glob list in sync with.gitignorewould be exactly the kind of drift this repo already has enough of.Deletion is then restricted by an allowlist of repository-owned paths (
CLEAN_TOP_LEVEL_DIRS/CLEAN_TOP_LEVEL_ARTIFACTS), so an unrecognized ignored directory at the top level is preserved rather than removed just for being ignored..pixiand hand-made virtualenvs are protected at any depth: they are expensive or developer-local, and are never the cause of a stale-artifact build failure.Rejected alternative
The first attempt was a one-liner:
git clean -Xdfwith:(exclude)pathspecs and no script at all. Dropped, because on git 2.43 the presence of an exclude pathspec changes matching for the positive pathspecs too — the command silently listed paths outside the directories it was given (ci/tools/__pycache__,.mypy_cache) while failing to actually exclude.pixi. Not something to build a destructive command on.Verification
Dry run against a dirty worktree: 212 paths, 698 MiB, with
.pixiand.venvcorrectly preserved. Unit-checked the path-classification rules across 14 cases (package artifacts, root artifacts, protected dirs at depth, unknown root dot-dirs).PLC Local Security Evidence (Advisory)
Local advisory checks only. Authoritative release gates remain Pulse, SonarQube, Coverity, BlackDuck, nSpect, ScanSpect, OSRB, and Anchore — none of the rows below are release-gate results.
gitlab-master.nvidia.com:5005(needs a PAT withread_registry)pixi.lockis a conda+PyPI lockfile; pip-licenses reads only installed Python distribution metadata and has nopixi.lockparser. BlackDuck + OSRB remain authoritativetoolshed/clean.py) but no manifest or lockfile is in scope. The script imports only the Python standard library, so there is nothing to resolve; recorded rather than suppressedgit statusand are filtered through a path allowlist beforeshutil.rmtree