Skip to content

Commit

Permalink
CRAN release 1.0.3 (#1691)
Browse files Browse the repository at this point in the history
* prepare for release

* CRAN has trouble talking to graphviz
  • Loading branch information
kevinushey authored Sep 20, 2023
1 parent 816ed3e commit e49d9be
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 53 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]",
comment = c(ORCID = "0000-0003-2880-7407")),
Expand Down
3 changes: 2 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
4 changes: 1 addition & 3 deletions R/graph.R
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://graphviz.org/doc/info/attrs.html>
#' 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
#'
Expand Down
4 changes: 1 addition & 3 deletions man/graph.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/ci.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
56 changes: 12 additions & 44 deletions vignettes/packages.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
<name>-<id>
```

If you'd prefer to omit the `<id>`, 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`.

0 comments on commit e49d9be

Please sign in to comment.