R/add_github_actions_check.R
add_github_actions_check.Rd
This function creates a configuration file (.yaml
) to setup GitHub Actions
to check the package.
This workflow is derived
from https://github.com/r-lib/actions/tree/v2-branch/examples.
This file will be written as .github/workflows/R-CMD-check.yaml
.
add_github_actions_check(open = FALSE, overwrite = FALSE, quiet = FALSE)
A logical value. If TRUE
(default) the file is opened in the
editor.
A logical value. If this file is already present and
overwrite = TRUE
, it will be erased and replaced. Default is FALSE
.
A logical value. If TRUE
messages are deleted. Default is
FALSE
.
No return value.
This workflow runs R CMD check
on the three major operating systems
(Ubuntu, macOS, and Windows) using the latest release of R. The package is
also checked on Ubuntu (latest version) using the development and previous
versions of R.
Other development functions:
add_dependencies()
,
add_github_actions_citation()
,
add_github_actions_codecov()
,
add_github_actions_document()
,
add_github_actions_pkgdown()
,
add_github_actions_render()
,
add_r_depend()
,
add_to_buildignore()
,
add_to_gitignore()
if (FALSE) {
add_github_actions_check()
}