allow BugReports to be an email

fixes #2275
r-lib · Aug 15, 2024 · ca04c6b · ca04c6b
1 parent 1d40a80
commit ca04c6b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/R/build-home-index.R b/R/build-home-index.R
@@ -158,10 +158,13 @@ data_home_sidebar_links <- function(pkg = ".") {
   repo <- cran_link(pkg$package)
   links <- config_pluck(pkg, "home.links")
 
+  bug_reports <- pkg$desc$get_field("BugReports", default = NULL)
+  if (grepl("@", bug_reports)) bug_reports <- paste0("mailto:", bug_reports)
+
   links <- c(
     link_url(sprintf(tr_("View on %s"), repo$repo), repo$url),
     link_url(tr_("Browse source code"), repo_home(pkg)),
-    link_url(tr_("Report a bug"), pkg$desc$get_field("BugReports", default = NULL)),
+    link_url(tr_("Report a bug"), bug_reports),
     purrr::map_chr(links, ~ link_url(.$text, .$href))
   )
 

diff --git a/tests/testthat/test-build-home-index.R b/tests/testthat/test-build-home-index.R
@@ -153,3 +153,10 @@ test_that("cran_unquote works", {
     "Quoting is CRAN's thing."
   )
 })
+
+test_that("allow email in BugReports", {
+  # currently desc throws a warning if BugReports is an email
+  pkg <- local_pkgdown_site(desc = list(BugReports = "[email protected]"))
+  html <- xml2::read_html(data_home_sidebar(pkg))
+  expect_snapshot(xpath_xml(html, ".//li/a"))
+})