R/add_github_actions_render.R
add_github_actions_render.Rd
This function creates a configuration file (.yaml
) to setup GitHub Actions
to automatically knit the README.Rmd
after a push. This workflow will be
triggered only if the README.Rmd
has been modified since the last commit.
This workflow is derived
from https://github.com/r-lib/actions/tree/v2-branch/examples.
This file will be written as .github/workflows/render-README.yaml
.
add_github_actions_render(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.
Other development functions:
add_dependencies()
,
add_github_actions_check()
,
add_github_actions_codecov()
,
add_github_actions_pkgdown()
,
add_r_depend()
,
add_to_buildignore()
,
add_to_gitignore()
if (FALSE) {
add_github_actions_render()
}