Skip to contents

Install a cffr GitHub Action

Source: R/cff_gha_update.R
cff_gha_update.Rd

This function would install a GitHub Action on your repo. The action will update your CITATION.cff when any of these events occur:

  • You publish a new release of the package.

  • Your DESCRIPTION or inst/CITATION are modified.

  • The action can be run also manually.

Usage

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

Arguments

path

Project directory

overwrite

If already present, do you want to overwrite your action?

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 helpers: cff_git_hook

Examples

if (FALSE) {
cff_gha_update()
}