Skip to content

Report rcheck envvars #237

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Report rcheck envvars #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a5b7cd
add _R_CHECK envvar printing to rcmdcheck(), closes #172
tanho63 Sep 19, 2025
c889c41
suggestions from @hadley review
tanho63 Sep 26, 2025
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
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

* `cran_check_results()` works again.

* `rcmdcheck()` now will print relevant environment variables (#172, @tanho63)

# rcmdcheck 1.4.0

* `cran_check_results()` now downloads results in parallel, so it is
Expand Down
45 changes: 39 additions & 6 deletions R/package.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,9 @@ rcmdcheck <- function(
}

# Add pandoc to the PATH, for R CMD build and R CMD check
if (should_use_rs_pandoc()) local_path(Sys.getenv("RSTUDIO_PANDOC"))
if (should_use_rs_pandoc()) {
local_path(Sys.getenv("RSTUDIO_PANDOC"))
}

pkgbuild::without_cache(pkgbuild::local_build_tools())

Expand Down Expand Up @@ -175,7 +177,9 @@ rcmdcheck <- function(

on.exit(unlink(out$session_info, recursive = TRUE), add = TRUE)

if (isTRUE(out$timeout)) message("R CMD check timed out")
if (isTRUE(out$timeout)) {
message("R CMD check timed out")
}

res <- new_rcmdcheck(
stdout = out$result$stdout,
Expand All @@ -188,7 +192,9 @@ rcmdcheck <- function(
)

# Automatically delete temporary files when this object disappears
if (cleanup) res$cleaner <- auto_clean(check_dir)
if (cleanup) {
res$cleaner <- auto_clean(check_dir)
}

handle_error_on(res, error_on)

Expand Down Expand Up @@ -227,9 +233,34 @@ do_check <- function(
}

# user supplied env vars take precedence
if (length(env)) chkenv[names(env)] <- env
if (length(env)) {
chkenv[names(env)] <- env
}

if (!quiet) {
cat_head("R CMD check")
cat_line()
all_vars <- Sys.getenv()
rchk_vars <- all_vars[
grep("_R_CHECK|NOT_CRAN|RCMDCHECK|R_TESTS", names(all_vars))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you could just print _R_CHECK var here — the idea is that devtools prints the env vars that it sets; rcmdcheck prints all the env vars that affect the operation of R CMD check, regardless of how they've been setting.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that it looked a little duplicative when called from devtools::check() and that we could let it all be handled by rcmdcheck? Here's what it looks like when you call devtools::check() with the PR rcmdcheck + release version devtools (note that it reprints the same variables, basically):

R> devtools::check("~/_nflverse/nflreadr")
══ Documenting ══════════════════════════════════════════════════════════════════════════════
ℹ Updating nflreadr documentation
ℹ Loading nflreadr

══ Building ═════════════════════════════════════════════════════════════════════════════════
Setting env vars:
• CFLAGS    : -Wall -pedantic -fdiagnostics-color=always
• CXXFLAGS  : -Wall -pedantic -fdiagnostics-color=always
• CXX11FLAGS: -Wall -pedantic -fdiagnostics-color=always
• CXX14FLAGS: -Wall -pedantic -fdiagnostics-color=always
• CXX17FLAGS: -Wall -pedantic -fdiagnostics-color=always
• CXX20FLAGS: -Wall -pedantic -fdiagnostics-color=always
── R CMD build ──────────────────────────────────────────────────────────────────────────────
✔  checking for file ‘/home/tan/_nflverse/nflreadr/DESCRIPTION’ ...
─  preparing ‘nflreadr’:
✔  checking DESCRIPTION meta-information ...
─  installing the package to build vignettes
✔  creating vignettes (7s)
─  checking for LF line-endings in source and make files and shell scripts (591ms)
─  checking for empty or unneeded directories
─  building ‘nflreadr_1.5.0.tar.gz’
   
══ Checking ═════════════════════════════════════════════════════════════════════════════════
Setting env vars:
• _R_CHECK_CRAN_INCOMING_USE_ASPELL_           : TRUE
• _R_CHECK_CRAN_INCOMING_REMOTE_               : FALSE
• _R_CHECK_CRAN_INCOMING_                      : FALSE
• _R_CHECK_FORCE_SUGGESTS_                     : FALSE
• _R_CHECK_PACKAGES_USED_IGNORE_UNUSED_IMPORTS_: FALSE
• NOT_CRAN                                     : true
── R CMD check ──────────────────────────────────────────────────────────────────────────────

─ R CMD check env vars set:
• _R_CHECK_CRAN_INCOMING_                       = FALSE
• _R_CHECK_CRAN_INCOMING_REMOTE_                = FALSE
• _R_CHECK_CRAN_INCOMING_USE_ASPELL_            = TRUE
• _R_CHECK_FORCE_SUGGESTS_                      = FALSE
• _R_CHECK_PACKAGES_USED_IGNORE_UNUSED_IMPORTS_ = FALSE
• NOT_CRAN                                      = true

My initial instinct was to make printing the envvars that relate to checking all get printed by rcmdcheck (even if set by devtools or otherwise), so also made a corresponding PR to remove the printing by devtools r-lib/devtools#2621

Copy link
Author

@tanho63 tanho63 Sep 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as for the RCMDCHECK / R_TESTS grep patterns, I did a search through the rcmdcheck codebase for Sys.getenv https://github.com/search?q=repo%3Ar-lib%2Frcmdcheck%20Sys.getenv&type=code and saw those two patterns being referred to in a handful of places, figured they might as well get printed

Copy link
Author

@tanho63 tanho63 Sep 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I'm happy to change to "just" the _R_CHECK ones if we have a stronger preference to have devtools print the vars set by devtools, just explaining the original rationale)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we had this, we'd drop the R_CHECK_ printing in devtools, but still set the other envvars.

rcmdcheck is used in other places apart from devtools, so the goals are a little different — here I'm worried more about env vars that are set elsewhere (i.e. not by devtools). We can also wait for Gabor to take a look.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we had this, we'd drop the R_CHECK_ printing in devtools, but still set the other envvars.

Yeah, I think that's what I tried to implement here (maybe worth eyeballing to confirm?) https://github.com/r-lib/devtools/pull/2621/files

]
rchk_vars[names(env)] <- env

if (length(rchk_vars) > 0) {
cli::cat_bullet(
"With:",
col = "darkgrey",
bullet = "line",
bullet_col = "darkgrey"
)
cli::cat_bullet(
paste0(format(names(rchk_vars)), " = ", unname(rchk_vars)),
col = "darkgrey"
)
cat_line()
}
}

if (!quiet) cat_head("R CMD check")
callback <- if (!quiet) detect_callback(as_cran = "--as-cran" %in% args)
res <- rcmd_safe(
"check",
Expand All @@ -246,7 +277,9 @@ do_check <- function(
)

# To print an incomplete line on timeout or crash
if (!is.null(callback) && (res$timeout || res$status != 0)) callback("\n")
if (!is.null(callback) && (res$timeout || res$status != 0)) {
callback("\n")
}

# Non-zero status is an error, the check process failed
# R CMD check returns 1 for installation errors, we don't want to error
Expand Down
Loading