Add and propagate quiet arg to build_site() (#2899)

Closes #2330

Author: jayhesselberth

DESCRIPTION

@@ -70,7 +70,7 @@ Config/Needs/website: usethis, servr
 Config/potools/style: explicit
 Config/testthat/edition: 3
 Config/testthat/parallel: true
-Config/testthat/start-first: build-article, build-quarto-article, build-reference
+Config/testthat/start-first: build-article, build-quarto-article, build-reference, build
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 SystemRequirements: pandoc

NEWS.md

@@ -1,5 +1,8 @@
 # pkgdown (development version)
 
+* `build_site()` gained a `quiet` argument, which is propagated to other functions
+  (e.g., `build_articles()`) and is useful for debugging build errors on GH actions.
+
 # pkgdown 2.1.3
 
 * Menu items can now set `class` and `id`.

R/build.R

@@ -301,6 +301,8 @@
 #'   in the current process affects the build process.
 #' @param install If `TRUE`, will install the package in a temporary library
 #'   so it is available for vignettes.
+#' @param quiet If `FALSE`, generate build messages for build functions that
+#'   take `quiet` arguments.
 #' @export
 #' @examples
 #' \dontrun{
@@ -318,7 +320,8 @@ build_site <- function(
   preview = NA,
   devel = FALSE,
   new_process = !devel,
-  install = !devel
+  install = !devel,
+  quiet = TRUE
 ) {
   pkg <- as_pkgdown(pkg, override = override)
   check_bool(devel)
@@ -352,7 +355,8 @@ build_site <- function(
       lazy = lazy,
       override = override,
       preview = preview,
-      devel = devel
+      devel = devel,
+      quiet = quiet
     )
   } else {
     build_site_local(
@@ -363,7 +367,8 @@ build_site <- function(
       lazy = lazy,
       override = override,
       preview = preview,
-      devel = devel
+      devel = devel,
+      quiet = quiet
     )
   }
 }
@@ -376,7 +381,8 @@ build_site_external <- function(
   lazy = FALSE,
   override = list(),
   preview = NA,
-  devel = TRUE
+  devel = TRUE,
+  quiet = TRUE
 ) {
   pkg <- as_pkgdown(pkg, override = override)
   args <- list(
@@ -390,6 +396,7 @@ build_site_external <- function(
     preview = FALSE,
     new_process = FALSE,
     devel = devel,
+    quiet = quiet,
     cli_colors = cli::num_ansi_colors(),
     hyperlinks = cli::ansi_has_hyperlink_support()
   )
@@ -422,7 +429,8 @@ build_site_local <- function(
   lazy = FALSE,
   override = list(),
   preview = NA,
-  devel = TRUE
+  devel = TRUE,
+  quiet = TRUE
 ) {
   pkg <- section_init(pkg, override = override)
 
@@ -438,7 +446,7 @@ build_site_local <- function(
     init_site(pkg, override)
   }
 
-  build_home(pkg, override = override, preview = FALSE)
+  build_home(pkg, override = override, quiet = quiet, preview = FALSE)
   build_reference(
     pkg,
     lazy = lazy,
@@ -449,7 +457,13 @@ build_site_local <- function(
     preview = FALSE,
     devel = devel
   )
-  build_articles(pkg, lazy = lazy, override = override, preview = FALSE)
+  build_articles(
+    pkg,
+    lazy = lazy,
+    override = override,
+    quiet = quiet,
+    preview = FALSE
+  )
   build_tutorials(pkg, override = override, preview = FALSE)
   build_news(pkg, override = override, preview = FALSE)
   build_sitemap(pkg)

man/build_site.Rd

@@ -1,3 +1,33 @@
 test_that("both versions of build_site have same arguments", {
   expect_equal(formals(build_site_local), formals(build_site_external))
 })
+
+test_that("build_site can be made unquiet", {
+  skip_if_no_pandoc()
+
+  # `quiet = FALSE` from build_site() should get passed to
+  # build_articles(), which will include some rmarkdown build out in the
+  # messages, including "pandoc", which won't be there normally
+  pkg <- local_pkgdown_site(test_path("assets/figure"))
+  output_unquiet <- suppressMessages(
+    capture.output(
+      build_site(
+        pkg,
+        quiet = FALSE,
+        preview = FALSE
+      )
+    )
+  )
+  expect_match(paste(output_unquiet, collapse = ""), "pandoc")
+
+  output_quiet <- suppressMessages(
+    capture.output(
+      build_site(
+        pkg,
+        preview = FALSE
+      )
+    )
+  )
+
+  expect_no_match(paste(output_quiet, collapse = ""), "pandoc")
+})