Skip to content

Ensure renv compat #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 25, 2021
Merged

Ensure renv compat #359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
835963e
compatibility only applies for small intersection of versions
lorenzwalthert Dec 25, 2021
3f5d26e
check on package load but only if interactive
lorenzwalthert Dec 25, 2021
a817d4a
mock pre-commit and renv
lorenzwalthert Dec 25, 2021
6f11516
mys setup
lorenzwalthert Dec 25, 2021
7b4a4aa
can't mock two functions -> test more low-level and expose as arg
lorenzwalthert Dec 25, 2021
b1bc8f6
format
lorenzwalthert Dec 25, 2021
0a23d18
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions R/setup.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,8 @@ autoupdate <- function(root = here::here()) {
})
}

ensure_renv_precommit_compat <- function(root = here::here()) {
ensure_renv_precommit_compat <- function(package_version_renv = utils::packageVersion("renv"),
root = here::here()) {
withr::local_dir(root)
path_config <- ".pre-commit-config.yaml"
config_lines <- readLines(path_config, encoding = "UTF-8")
Expand All @@ -187,10 +188,14 @@ ensure_renv_precommit_compat <- function(root = here::here()) {
{
rev <- rev_as_pkg_version(rev)
maximal_rev <- package_version("0.1.3.9014")
if (rev > maximal_rev) {
if (rev > maximal_rev &&
package_version_renv < "0.14.0-148" &&
package_version(version_precommit()) <= "2.16.0"
) {
rlang::warn(paste0(
"It seems like you want to use {renv} and {precommit} in the same ",
"repo. This is not well supported for users of RStudio and ",
"repo. This is not well supported for users of RStudio with ",
"`pre-commit <= 2.16.0`, `renv < 0.14.0-148` and ",
"`precommit > 0.1.3.9014` at the moment (details: ",
"https://github.com/lorenzwalthert/precommit/issues/342). ",
"Autoupdate aborted and `rev:` in `.pre-commit-config.yaml` set to ",
Expand Down
1 change: 1 addition & 0 deletions R/zzz.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
)
toset <- !(names(op.precommit) %in% names(op))
if (any(toset)) options(op.precommit[toset])
if (interactive()) ensure_renv_precommit_compat()
invisible()
}
6 changes: 1 addition & 5 deletions man/precommit-package.Rd
View file
Open in desktop

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

27 changes: 19 additions & 8 deletions tests/testthat/test-setup.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,12 @@ test_that("Pre-commit CI setup works", {
})


test_that("Autoupdate is not conducted when renv present", {
test_that("Autoupdate is not conducted when renv present in incompatible setup", {
skip_on_cran()

# mock old pre-commit and renv versions
mockery::stub(ensure_renv_precommit_compat, "version_precommit", "2.13.0")

local_test_setup(
git = TRUE, use_precommit = TRUE, install_hooks = FALSE, open = FALSE
)
Expand All @@ -94,16 +98,23 @@ test_that("Autoupdate is not conducted when renv present", {
writeLines("", "renv.lock")

# should downgrade rev
expect_warning(autoupdate(root = getwd()), "Autoupdate aborted")
expect_warning(
ensure_renv_precommit_compat(
package_version_renv = package_version("0.13.0"), root = getwd()
),
"Autoupdate aborted"
)
downgraded <- rev_read() %>%
rev_as_pkg_version()
expect_true(downgraded < initial)

# simulate removing {renv} should updagradd
# simulate removing {renv} should be updated
fs::file_delete("renv.lock")
expect_warning(autoupdate(root = getwd()), NA)
after_upgrade <- rev_read() %>%
rev_as_pkg_version()

expect_true(after_upgrade > downgraded)
expect_warning(
ensure_renv_precommit_compat(
package_version("0.13.0"),
root = getwd()
),
NA
)
})