Merged origin/main into deprecate-release

Author: hadley

DESCRIPTION

@@ -65,6 +65,7 @@ VignetteBuilder:
     knitr
 Config/Needs/website: tidyverse/tidytemplate
 Config/testthat/edition: 3
+Config/testthat/parallel: true
 Encoding: UTF-8
 Language: en-US
 Roxygen: list(markdown = TRUE)

NEWS.md

@@ -1,7 +1,9 @@
 # devtools (development version)
 
 * `build_manual()` reports more details on failure (#2586).
+* `build_site()` now just calls `pkgdown::build_site()`, meaning that you will get more (informative) output by default (#2578).
 * New `check_mac_devel()` function to check a package using the macOS builder at https://mac.r-project.org/macbuilder/submit.html (@nfrerebeau, #2507)
+* `dev_sitrep()` now works correctly in Positron (#2618).
 * `is_loading()` is now re-exported from pkgload (#2556).
 * `load_all()` now errors if called recursively, i.e. if you accidentally include a `load_all()` call in one of your R source files (#2617).
 * `release()` is deprecated in favour of `usethis::use_release_issue()`.

R/build-site.R

@@ -1,32 +1,14 @@
-#' Execute \pkg{pkgdown} build_site in a package
+#' Run `pkgdown::build_site()`
 #'
-#' `build_site()` is a shortcut for [pkgdown::build_site()], it generates the
-#'   static HTML documentation.
+#' This is a thin wrapper around [pkgdown::build_site()], used for generating
+#' static HTML documentation. Learn more at <https://pkgdown.r-lib.org>.
 #'
-#' @param path path to the package to build the static HTML.
-#' @param ...  additional arguments passed to [pkgdown::build_site()]
-#' @inheritParams install
-#'
-#' @return NULL
+#' @param path Path to the package to build the static HTML.
+#' @param ...  Additional arguments passed to [pkgdown::build_site()].
 #' @export
-build_site <- function(path = ".", quiet = TRUE, ...) {
+build_site <- function(path = ".", ...) {
   rlang::check_installed("pkgdown")
 
   save_all()
-
-  pkg <- as.package(path)
-
-  check_dots_used(action = getOption("devtools.ellipsis_action", rlang::warn))
-
-  withr::with_temp_libpaths(action = "prefix", code = {
-    install(pkg = pkg$path, upgrade = "never", reload = FALSE, quiet = quiet)
-    if (isTRUE(quiet)) {
-      withr::with_output_sink(
-        file_temp(),
-        pkgdown::build_site(pkg = pkg$path, ...)
-      )
-    } else {
-      pkgdown::build_site(pkg = pkg$path, ...)
-    }
-  })
+  pkgdown::build_site(pkg = path, ...)
 }

R/check-win.R

@@ -118,9 +118,7 @@ check_win <- function(
     ))
 
     email <- maintainer(pkg)$email
-    if (interactive() && yesno("Email results to {.strong {email}}?")) {
-      return(invisible())
-    }
+    confirm_maintainer_email(email)
   }
 
   built_path <- pkgbuild::build(
@@ -154,6 +152,24 @@ check_win <- function(
   invisible()
 }
 
+confirm_maintainer_email <- function(email, call = parent.frame()) {
+  if (!rlang::is_interactive()) {
+    return(FALSE)
+  }
+
+  if (!yesno("Email results to {.strong {email}}?")) {
+    return()
+  }
+
+  cli::cli_abort(
+    c(
+      "User declined upload.",
+      i = "Use `email = {.str your email}` to override."
+    ),
+    call = call
+  )
+}
+
 change_maintainer_email <- function(path, email, call = parent.frame()) {
   desc <- desc::desc(file = path)
 

R/sitrep.R

@@ -118,7 +118,7 @@ dev_sitrep <- function(pkg = ".", debug = FALSE) {
         remotes::dev_package_deps(pkg$path, dependencies = TRUE)
       },
       rstudio_version = if (is_rstudio_running()) rstudioapi::getVersion(),
-      rstudio_msg = check_for_rstudio_updates()
+      rstudio_msg = if (!is_positron()) check_for_rstudio_updates()
     ),
     class = "dev_sitrep"
   )
@@ -156,7 +156,7 @@ print.dev_sitrep <- function(x, ...) {
   }
 
   if (!is.null(x$rstudio_version)) {
-    hd_line("RStudio")
+    hd_line(if (is_positron()) "Positron" else "RStudio")
     kv_line("version", x$rstudio_version)
 
     if (!is.null(x$rstudio_msg)) {

R/utils.R

@@ -41,6 +41,10 @@ is_testing <- function() {
   identical(Sys.getenv("TESTTHAT"), "true")
 }
 
+is_positron <- function() {
+  Sys.getenv("POSITRON") == "1"
+}
+
 is_rstudio_running <- function() {
   !is_testing() && rstudioapi::isAvailable()
 }

man/build_site.Rd

@@ -0,0 +1,8 @@
+# Package pkgdown site can be built 
+
+    Code
+      build_site(path = "testPkgdown", override = list(destination = destination))
+    Message
+      -- Installing package testPkgdown into temporary library -----------------------
+      -- Finished building pkgdown site for package testPkgdown ----------------------
+

tests/testthat/_snaps/build-site.md

@@ -0,0 +1,19 @@
+# check_man works
+
+    Code
+      check_man(pkg)
+    Message
+      i Updating {package} documentation
+      i Loading {package}
+      i Checking documentation...
+    Output
+      Rd files without \alias:
+        'foo.Rd'
+      Rd files without \description:
+        'foo.Rd'
+      Argument items with no description in Rd file 'foo.Rd':
+        'foo'
+      Undocumented arguments in Rd file 'foo.Rd'
+        'x'
+      
+

tests/testthat/_snaps/check-doc.md

@@ -14,3 +14,14 @@
       Error:
       ! DESCRIPTION can't use Maintainer field when changing `email`
 
+# email confirmation gives useful advice
+
+    Code
+      confirm_maintainer_email("hadley@posit.co")
+    Message
+      Email results to hadley@posit.co?
+    Condition
+      Error:
+      ! User declined upload.
+      i Use `email = "your email"` to override.
+