docs(NEWS): align renv_paths_cache bullet with post-#106 default - #108
Merged
Conversation
The renv_paths_cache bullet still described the pre-#106 behaviour (default = "/root/.cache/R/renv"). After #106, the signature default is NULL with auto-derivation from `user`: /root for user = NULL, /home/<user> otherwise. Update the bullet to reflect the actual runtime, closing the doc-runtime drift introduced by the merge. No code change. No NAMESPACE / Rd impact.
There was a problem hiding this comment.
Pull request overview
This PR updates the dockerfiler 0.3.0 NEWS entry for dock_from_renv()’s renv_paths_cache parameter so the documented default matches the current runtime behavior introduced in #106 (auto-derivation from user when renv_paths_cache = NULL).
Changes:
- Rewrite the NEWS bullet for
renv_paths_cacheto documentNULL-default auto-derivation fromuser. - Clarify that
renv_paths_cachedrives theRENV_PATHS_CACHEbuild-arg default, propagatedENV, and cache mount target.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
The NEWS bullet for the
renv_paths_cacheparameter (added in0.3.0) still described the pre-#106 behaviour:
After #106 landed, the signature default flipped from a literal
string to
NULLwith auto-derivation fromuser:user = NULL->/root/.cache/R/renv(legacy).user = "<name>"(default"rstudio") ->/home/<name>/.cache/R/renv.This PR rewrites the NEWS bullet to document the auto-derive
contract verbatim, closing the doc-runtime drift introduced when
#106 was merged.
Test plan
rewrite in NEWS.md.
R/dock_from_renv.Rsignature (line 139), auto-derive branch (lines 160-166),
ARG/ENV emission (line 194), and cache mount target (line 367)
via pr-reviewer agent.
bullets.
Context
Surfaced during the post-merge sanity check on master 0.3.0.
Tier-zero polish before the CRAN release sequence.