R/macro-package-checks.R

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

#' do_package_checks
#'
#' The [do_package_checks()] macro adds default checks for R packages,
#' including installation of dependencies and running a test coverage
#' analysis.
#'
#' @include macro.R
#' @name macro
NULL

#' Add default checks for packages
#'
#' @description
#' `do_package_checks()` adds default steps related to package checks
#' to the `"before_install"`, `"install"`, `"script"` and `"after_success"`
#' stages:
#'
#' This macro is only available for R packages.
#'
#' @inheritParams step_rcmdcheck
#' @inheritParams step_install_pkg
#' @param codecov `[flag]`\cr Whether to include a step running
#'   `covr::codecov(quiet = FALSE)` (default: only for non-interactive CI,
#'   see [ci_is_interactive()]).
#' @family macros
#' @export
#' @examples
#' dsl_init()
#'
#' do_package_checks()
#'
#' dsl_get()
do_package_checks <- function(...,
                              codecov = !ci_is_interactive(),
                              warnings_are_errors = NULL,
                              notes_are_errors = NULL,
                              args = NULL,
                              build_args = NULL,
                              error_on = "warning",
                              repos = repo_default(),
                              dependencies = TRUE,
                              timeout = Inf,
                              check_dir = "check") {
  #' @description
  #' 1. [step_install_deps()] in the `"install"` stage, using the
  #'    `repos` argument.
  #' 1. [step_session_info()] in the `"install"` stage.
  get_stage("install") %>%
    add_step(
      step_install_deps(dependencies = {{ dependencies }})
    ) %>%
    add_step(
      step_session_info()
    )

  #' 1. [step_rcmdcheck()] in the `"script"` stage, using the
  #'    `warnings_are_errors`, `notes_are_errors`, `args`, and
  #'    `build_args` arguments.
  get_stage("script") %>%
    add_step(
      step_rcmdcheck(
        warnings_are_errors = !!enquo(warnings_are_errors),
        notes_are_errors = !!enquo(notes_are_errors),
        args = !!enquo(args),
        build_args = !!enquo(build_args),
        error_on = !!enquo(error_on),
        repos = !!enquo(repos),
        timeout = !!enquo(timeout),
        check_dir = !!enquo(check_dir)
      )
    )

  if (isTRUE(codecov)) {
    #' 1. A call to [covr::codecov()] in the `"after_success"` stage
    #'    (only if the `codecov` flag is set)
    get_stage("after_success") %>%
      add_code_step(covr::codecov(quiet = FALSE))
  }

  dsl_get()
}

#' Deprecated functions
#'
#' `add_package_checks()` has been replaced by [do_package_checks()].
#'
#' @inheritParams do_package_checks
#' @name Deprecated
#' @export
add_package_checks <- function(...,
                               warnings_are_errors = NULL,
                               notes_are_errors = NULL,
                               args = c("--no-manual", "--as-cran"),
                               build_args = "--force", error_on = "warning",
                               repos = repo_default(), timeout = Inf) {
  .Deprecated("do_package_checks")
  do_package_checks(
    ... = ...,
    warnings_are_errors = warnings_are_errors,
    notes_are_errors = notes_are_errors,
    args = args,
    build_args = build_args, error_on = error_on,
    repos = repos, timeout = timeout
  )
}