add_github_actions_pkgdown {rcompendium} | R Documentation |
Setup GitHub Actions to build and deploy package website
Description
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.
Usage
add_github_actions_pkgdown(open = FALSE, overwrite = FALSE, quiet = FALSE)
Arguments
open |
A logical value. If |
overwrite |
A logical value. If this file is already present and
|
quiet |
A logical value. If |
Value
No return value.
See Also
Other development functions:
add_dependencies()
,
add_github_actions_check()
,
add_github_actions_citation()
,
add_github_actions_codecov()
,
add_github_actions_document()
,
add_github_actions_render()
,
add_r_depend()
,
add_to_buildignore()
,
add_to_gitignore()
Examples
## Not run:
add_github_actions_pkgdown()
## End(Not run)