From e49d9be9528e0ff73b673f97382731c140013474 Mon Sep 17 00:00:00 2001 From: Kevin Ushey Date: Wed, 20 Sep 2023 08:22:25 -0700 Subject: [PATCH] CRAN release 1.0.3 (#1691) * prepare for release * CRAN has trouble talking to graphviz --- DESCRIPTION | 2 +- NEWS.md | 3 ++- R/graph.R | 4 +-- man/graph.Rd | 4 +-- vignettes/ci.Rmd | 2 +- vignettes/packages.Rmd | 56 +++++++++--------------------------------- 6 files changed, 18 insertions(+), 53 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 96cdff5bb..a54775a6b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: renv Type: Package Title: Project Environments -Version: 1.0.2.9000 +Version: 1.0.3 Authors@R: c( person("Kevin", "Ushey", role = c("aut", "cre"), email = "kevin@rstudio.com", comment = c(ORCID = "0000-0003-2880-7407")), diff --git a/NEWS.md b/NEWS.md index 4462127f4..af133eea0 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,5 @@ -# renv (development version) + +# renv 1.0.3 * Fixed an issue where `renv` could warn the project appeared to be out-of-sync when using packages installed without an explicit source recorded. (#1683) diff --git a/R/graph.R b/R/graph.R index 92824803c..0eb380cf0 100644 --- a/R/graph.R +++ b/R/graph.R @@ -23,9 +23,7 @@ #' #' @param attributes An \R list of graphViz attributes, mapping node names to #' attribute key-value pairs. For example, to ask graphViz to prefer orienting -#' the graph from left to right, you can use -#' `list(graph = c(rankdir = "LR"))`. See -#' for a full list of the attributes supported by `graphViz`. +#' the graph from left to right, you can use `list(graph = c(rankdir = "LR"))`. #' #' @examples #' diff --git a/man/graph.Rd b/man/graph.Rd index e92fb19ca..860760cb3 100644 --- a/man/graph.Rd +++ b/man/graph.Rd @@ -38,9 +38,7 @@ When \code{NULL} (the default), an internal resolver is used.} \item{attributes}{An \R list of graphViz attributes, mapping node names to attribute key-value pairs. For example, to ask graphViz to prefer orienting -the graph from left to right, you can use -\code{list(graph = c(rankdir = "LR"))}. See \url{https://graphviz.org/doc/info/attrs.html} -for a full list of the attributes supported by \code{graphViz}.} +the graph from left to right, you can use \code{list(graph = c(rankdir = "LR"))}.} \item{project}{The project directory. If \code{NULL}, then the active project will be used. If no project is currently active, then the current working diff --git a/vignettes/ci.Rmd b/vignettes/ci.Rmd index 589bbfd26..f66b38b37 100644 --- a/vignettes/ci.Rmd +++ b/vignettes/ci.Rmd @@ -115,7 +115,7 @@ before_script: ``` -[gitlab-ci]: https://about.gitlab.com/features/continuous-integration/ +[gitlab-ci]: https://about.gitlab.com/solutions/continuous-integration/ [github-actions]: https://github.com/features/actions [github-actions-renv]: https://github.com/actions/cache/blob/main/examples.md#r---renv [r-lib-actions-renv]: https://github.com/r-lib/actions/tree/v2-branch/setup-renv diff --git a/vignettes/packages.Rmd b/vignettes/packages.Rmd index 08bfd1552..a9f08bd5f 100644 --- a/vignettes/packages.Rmd +++ b/vignettes/packages.Rmd @@ -78,52 +78,20 @@ for an example of how renv uses itself for package management in its own CI tests. -## `R CMD build` and the project library +## Submitting to CRAN -By default, when building a package tarball, R will copy all files within the -package directory to a temporary build directory before building the package. -This can be time consuming if your project contains a large number of files. -For this reason, renv places the project library for package projects within -a separate external directory by default. This directory is: +Note that packages submitted to CRAN should be designed to work with the other R +packages currently available on CRAN. For that reason, when preparing your package +for submission, you'll need to ensure your source package tarball does not +include any `renv` infrastructure. `renv` makes this easy by automatically +including ``` -tools::R_user_dir("renv/library", "cache") +^renv$ +^renv\.lock$ ``` -If you want to use your own custom path, you can use, for example: - -``` -RENV_PATHS_LIBRARY_ROOT = ~/.renv/library -``` - -If you'd prefer to keep your project library within the project directory, -you can instead set: - -``` -RENV_PATHS_LIBRARY = renv/library -``` - -within an appropriate `.Renviron` startup profile. - -By default, library paths will be formed using the project name, alongside a -unique identifier generated from the full project path. These paths are of -the form: - -``` -- -``` - -If you'd prefer to omit the ``, then you can set the environment variable: - -``` -RENV_PATHS_LIBRARY_ROOT_ASIS = TRUE -``` - -to instruct renv to forego the use of an identifier. - - - - -[ci]: https://CRAN.R-project.org/package=renv/vignettes/ci.html -[dependencies]: https://CRAN.R-project.org/package=remotes/vignettes/dependencies.html - +in your package's `.Rbuildignore` file. This instructs `R CMD build` to not +include these files and folders in the generated package tarball. Through this, +even if `renv` is used during package development, it's still easy to build and +publish your package to CRAN as you would when developing packages without `renv`.