docs(ci-setup): document TOOLR_VENV_LOCATION and the action's in-tree default#375
Merged
Conversation
… default The toolr-ci-setup skill described the action caching the per-repo `tools/.venv` but never named the mechanism, so the in-tree behaviour read as magic. Add a "Where the venv lives in CI" section explaining: - Locally the venv defaults to the volatile per-repo cache dir; the `s0undt3ch/ToolR` action exports `TOOLR_VENV_LOCATION=in-tree` to force `tools/.venv/`, which is what the venv cache keys on. - Action users set nothing; only bare `run:` steps that skip the action need to export the env var themselves. Also add `TOOLR_VENV_LOCATION` / "in-tree venv in CI" to the skill's discovery triggers and cross-link the docs' venv-location reference.
Owner
Author
|
This change is part of the following stack: Change managed by git-spice. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #375 +/- ##
=======================================
- Coverage 93.8% 93.8% -0.1%
=======================================
Files 96 96
Lines 15810 15939 +129
Branches 118 118
=======================================
+ Hits 14838 14958 +120
- Misses 962 971 +9
Partials 10 10
Flags with carried forward coverage won't be shown. Click here to find out more.
|
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
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.
Why
toolr supports an in-repo (
tools/.venv) venv via theTOOLR_VENV_LOCATIONenv key (acceptsin-tree/cache), whose stated primary use case is CI. The behaviour is fully documented indocs/project-config.md, but thetoolr-ci-setupskill never named it: it described the action "caching the per-repotools/.venv" and had a cache-miss failure mode, yet never explained why the venv lives in-tree on CI (locally it defaults to the XDG cache dir). The in-tree behaviour read as magic.What changed
Skill-only edit to
skills/toolr-ci-setup/SKILL.md:s0undt3ch/ToolRaction exportsTOOLR_VENV_LOCATION=in-treeto forcetools/.venv/, which is exactly what thetools/.venvcache (cache-tools-venv) keys on.run:step without the action? ExportTOOLR_VENV_LOCATION: in-treeyourself so the venv lands somewhere cacheable (with a YAML snippet).TOOLR_VENV_LOCATION/ "in-tree venv in CI" to the skill's discovery triggers.venv-locationreference.Verification
Skill-only scope (no
docs/, Rust, or Python touched):cargo xtask build-skill-refs --check✅prek runon the changed file ✅