add_github_actions_check: Setup GitHub Actions to check package

Description Usage Arguments Details Value See Also Examples

View source: R/add_github_actions_check.R

Description

This function creates a configuration file (.yaml) to setup GitHub Actions to check the package. This file will be written (from a template adapted from usethis::use_github_action()) in the folder .github/workflows/R-CMD-check.yaml.

Usage

1
add_github_actions_check(open = FALSE, overwrite = FALSE, quiet = FALSE)

Arguments

open

a logical value

If TRUE (default) the file is opened in the editor.

overwrite

a logical value

If this file is already present and overwrite = TRUE, it will be erased and replaced. Default is FALSE.

quiet

a logical value

If TRUE messages are deleted. Default is FALSE.

Details

This workflow runs R CMD check on the three major operating systems (Ubuntu, macOS, and Windows) on the latest release of R. If user want to change this setting he can replace this .yaml file be another (e.g. generated by running usethis::use_github_action()).

Value

None

See Also

Other development functions: add_dependencies(), add_github_actions_codecov(), add_github_actions_pkgdown(), add_r_depend(), add_to_buildignore(), add_to_gitignore()

Examples

1
2
3
4
## Not run: 
add_github_actions_check()

## End(Not run)

rcompendium documentation built on March 24, 2021, 5:06 p.m.