add_github_actions_pkgdown: Setup GitHub Actions to build and deploy package website

Description Usage Arguments Value See Also Examples

View source: R/add_github_actions_pkgdown.R

Description

This function creates a configuration file (.yaml) to setup GitHub Actions to automatically build and deploy the website using pkgdown. This file will be written (from a template adapted from usethis::use_github_action()) in the folder .github/workflows/pkgdown.yaml. An additional empty file (_pkgdown.yaml) will also be written: it can be used to customize the website.

Usage

1
add_github_actions_pkgdown(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.

Value

None

See Also

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

Examples

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

## End(Not run)

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