cff_gha_update: Install a 'cffr' GitHub Action

In cffr: Generate Citation File Format ('cff') Metadata for R Packages

Install a cffr GitHub Action

Description

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 root directory.
overwrite	Logical. If already present, do you want to overwrite your action?

Details

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

Value

Invisible, this function is called by its side effects.

See Also

Other Git/GitHub helpers provided by cffr: cff_git_hook

Examples

## Not run: 
cff_gha_update()

## End(Not run)

cffr documentation built on April 3, 2025, 9:33 p.m.