R/add_github_actions_pkgdown.R
add_github_actions_pkgdown.Rd
This function creates a configuration file (.yaml
) to setup GitHub Actions
to automatically build and deploy the website using
pkgdown
. This workflow is derived
from https://github.com/r-lib/actions/tree/v2-branch/examples.
This file will be written as .github/workflows/pkgdown.yaml
.
An additional empty file (_pkgdown.yaml
) will also be written: it can be
used to customize the website.
add_github_actions_pkgdown(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_render()
,
add_r_depend()
,
add_to_buildignore()
,
add_to_gitignore()
if (FALSE) {
add_github_actions_pkgdown()
}