R/steps-pkgdown.R

In ropenscilabs/tic: Tasks Integrating Continuously: CI-Agnostic Workflow Definitions

#' @include steps-rcmdcheck.R
BuildPkgdown <- R6Class(
  "BuildPkgdown",
  inherit = TicStep,
  public = list(
    initialize = function(...) {
      private$pkgdown_args <- list(...)
      super$initialize()
    },
    run = function() {
      # pak::local_install(".")
      if (dir.exists("docs")) {
        pkgdown::clean_site()
      }
      do.call(
        pkgdown::build_site, c(list(preview = FALSE), private$pkgdown_args)
      )
    },
    prepare = function() {
      if (!file.exists("DESCRIPTION")) {
        cli::cli_alert_danger("The {.code step_build_pkgdown()} step and the
                         {.code do_pkgdown()} macro are only available
                         for packages.", wrap = TRUE)
        stopc("No DESCRIPTION file found.")
      }
      verify_install("pkgdown")
      super$prepare()
    }
  ),
  private = list(
    pkgdown_args = NULL
  )
)

#' Step: Build pkgdown documentation
#'
#' Builds package documentation with the \pkg{pkgdown} package.
#' Calls `pkgdown::clean_site()` and then `pkgdown::build_site(...)`.
#'
#' @inheritDotParams pkgdown::build_site
#' @family steps
#' @export
#' @examples
#' dsl_init()
#'
#' get_stage("script") %>%
#'   add_step(step_build_pkgdown())
#'
#' dsl_get()
step_build_pkgdown <- function(...) {
  BuildPkgdown$new(...)
}