Install a cffr GitHub Action

This function installs a GitHub Action on your repository. The action 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 action already exists, should it be overwritten?

Value

Invisible, this function is called by its side effects.

Details

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

See also

Other Git/GitHub helpers provided by cffr: cff_git_hook

Examples

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