diff --git a/DESCRIPTION b/DESCRIPTION index 6bf5392..a406e81 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: gDRstyle Type: Package Title: A package with style requirements for the gDR suite -Version: 1.7.1 -Date: 2025-04-16 +Version: 1.7.2 +Date: 2025-05-26 Authors@R: c( person("Allison", "Vuong", role=c("aut")), person("Dariusz", "Scigocki", role=c("aut")), @@ -36,6 +36,7 @@ Imports: withr Suggests: knitr, + pkgdown, testthat (>= 3.0.0) URL: https://github.com/gdrplatform/gDRstyle, https://gdrplatform.github.io/gDRstyle/ BugReports: https://github.com/gdrplatform/gDRstyle/issues diff --git a/NEWS.md b/NEWS.md index e7b3bda..0221547 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,6 @@ +## gDRstyle 1.7.2 - 2025-05-26 +* add check for `pkgdown` in the `checkPackage` function + ## gDRstyle 1.7.1 - 2025-04-16 * synchronize Bioconductor and GitHub versioning diff --git a/R/check.R b/R/check.R index 52a68f6..2ce4119 100644 --- a/R/check.R +++ b/R/check.R @@ -186,6 +186,7 @@ rcmd_check_with_notes <- function(pkgDir, #' @param run_examples Logical whether examples check should be performed #' @param skip_lint skip lint checks #' @param skip_tests skip tests +#' @param skip_pkgdown skip pkgdown build #' @param build_vignettes build vignettes #' @param check_vignettes check vignettes #' @param as_cran run with as_cran flag @@ -208,6 +209,7 @@ checkPackage <- function(pkgName, run_examples = TRUE, skip_lint = FALSE, skip_tests = FALSE, + skip_pkgdown = FALSE, build_vignettes = TRUE, check_vignettes = TRUE, as_cran = FALSE) { @@ -246,6 +248,15 @@ checkPackage <- function(pkgName, message("Tests skipped") } + if (!skip_pkgdown) { + message("Pkgdown") + pkgdown::build_site( + pkg = pkgDir, + override = list(destination = tempfile()), + preview = FALSE + ) + } + message("Check") utils::timestamp() rcmd_check_with_notes( diff --git a/man/checkPackage.Rd b/man/checkPackage.Rd index 62dea80..e4e5893 100644 --- a/man/checkPackage.Rd +++ b/man/checkPackage.Rd @@ -13,6 +13,7 @@ checkPackage( run_examples = TRUE, skip_lint = FALSE, skip_tests = FALSE, + skip_pkgdown = FALSE, build_vignettes = TRUE, check_vignettes = TRUE, as_cran = FALSE @@ -37,6 +38,8 @@ values: \code{"note"}, \code{"warning"} (default) and \code{"error"}.} \item{skip_tests}{skip tests} +\item{skip_pkgdown}{skip pkgdown build} + \item{build_vignettes}{build vignettes} \item{check_vignettes}{check vignettes}