docs: document per-target remote cache exclusion (cache.remote)#38
Open
raphaelvigee wants to merge 1 commit into
Open
docs: document per-target remote cache exclusion (cache.remote)#38raphaelvigee wants to merge 1 commit into
raphaelvigee wants to merge 1 commit into
Conversation
Following hephbuild/heph#108 which fixed the engine to actually honor the per-target `remote_enabled` flag. The cache={remote: False} option existed and was set by the nix driver, but was silently ignored by the engine. Now that it works, document it in both exec.md and remote-cache.md.
⚡ Cloudflare Pages preview
|
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 changed
hephbuild/heph#108 fixed a bug where the engine ignored
cache.remote_enabledwhen deciding to push or pull from a remote cache. Thecache = {"remote": False}option existed in the exec driver spec and was actively used by the nix driver, but the engine never read the flag — so nix wrapper artifacts (which embed absolute/nix/storepaths) were uploaded and pulled across machines anyway, causingexit 127failures.Now that the fix is in, document the feature properly:
website/docs/guides/remote-cache.md— new "Excluding targets from the remote cache" section explaining when and how to usecache = {"remote": False}on individual targets, with a concrete BUILD example.website/docs/plugins/exec.md— updated thecachetable row to clarify the bool vs. dict forms, and added a new "Cache control" section documenting the three dict keys (enabled,remote,history) with their defaults and a worked example ofremote: False.Related
Generated by Claude Code