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.
step_install_deps()
in the"install"
stage, using therepos
argument.step_session_info()
in the"install"
stage.step_rcmdcheck()
in the"script"
stage, using thewarnings_are_errors
,notes_are_errors
,args
, andbuild_args
arguments.A call to
covr::codecov()
in the"after_success"
stage (only if thecodecov
flag is set)
Usage
do_package_checks(
...,
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"
)
Arguments
- ...
Ignored, used to enforce naming of arguments.
- codecov
[flag]
Whether to include a step runningcovr::codecov(quiet = FALSE)
(default: only for non-interactive CI, seeci_is_interactive()
).- warnings_are_errors, notes_are_errors
[flag]
Deprecated, useerror_on
.- args
[character]
Passed torcmdcheck::rcmdcheck()
.Default for local runs:
c("--no-manual", "--as-cran")
.Default for Windows:
c("--no-manual", "--as-cran", "--no-vignettes", "--no-build-vignettes", "--no-multiarch")
.On GitHub Actions option "--no-manual" is always used (appended to custom user input) because LaTeX is not available and installation is time consuming and error prone.
- build_args
[character]
Passed torcmdcheck::rcmdcheck()
.
Default for local runs:"--force"
.
Default for Windows:c("--no-build-vignettes", "--force")
.- error_on
[character]
Whether to throw an error on R CMD check failures. Note that the check is always completed (unless a timeout happens), and the error is only thrown after completion. If "never", then no errors are thrown. If "error", then only ERROR failures generate errors. If "warning", then WARNING failures generate errors as well. If "note", then any check failure generated an error.- repos
[character]
Passed torcmdcheck::rcmdcheck()
, default:repo_default()
.- dependencies
Dependency types. See
pkgdepends::as_pkg_dependencies()
for possible values. Note that changing this argument from the default might result an installation failure, e.g. if you set it toFALSE
, packages might not build if their dependencies are not already installed.- timeout
[numeric]
Passed torcmdcheck::rcmdcheck()
, default:Inf
.- check_dir
[character]
Path specifying the directory for R CMD check. Defaults to"check"
for easy upload of artifacts.
See also
Other macros:
do_blogdown()
,
do_bookdown()
,
do_drat()
,
do_pkgdown()
,
do_readme_rmd()
,
list_macros()
Examples
dsl_init()
#> ✔ Creating a clean tic stage configuration
#> ℹ See `?tic::dsl_get` for details
do_package_checks()
#> ── tic configuration summary ───────────────────────────────────────────────────
#> ── Stage: install ──────────────────────────────────────────────────────────────
#> ▶ step_install_deps(dependencies=TRUE)
#> ▶ step_session_info()
#> ── Stage: script ───────────────────────────────────────────────────────────────
#> ▶ step_rcmdcheck(warnings_are_errors=NULL, notes_are_errors=NULL, args=NULL, build_args=NULL, error_on="warning", repos=repo_default(), timeout=Inf, check_dir="check")
dsl_get()
#> ── tic configuration summary ───────────────────────────────────────────────────
#> ── Stage: install ──────────────────────────────────────────────────────────────
#> ▶ step_install_deps(dependencies=TRUE)
#> ▶ step_session_info()
#> ── Stage: script ───────────────────────────────────────────────────────────────
#> ▶ step_rcmdcheck(warnings_are_errors=NULL, notes_are_errors=NULL, args=NULL, build_args=NULL, error_on="warning", repos=repo_default(), timeout=Inf, check_dir="check")