Install a cffr GitHub Actions workflow

This function installs a GitHub Actions workflow in your repository. The workflow updates your CITATION.cff when any of these events occur:

• You publish a new release of the package.

• Your DESCRIPTION or inst/CITATION file is modified.

• The action can be run manually.

Usage

cff_gha_update(path = ".", overwrite = FALSE)

Arguments

path

Project root directory.

overwrite

Logical. If the workflow already exists, whether to overwrite it.

Value

Invisible. This function is called for its side effects.

Details

Triggers on your action can be modified. See Events that trigger workflows.

See also

Keep CITATION.cff up to date: cff_git_hook

Examples

if (FALSE) { # \dontrun{
cff_gha_update()
} # }