cff_gha_update: Install a 'cffr' GitHub Actions workflow

In cffr: Generate Citation File Format ('CFF') Metadata

Install a cffr GitHub Actions workflow

Description

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 workflow can be run manually.

Usage

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

Arguments

path	Project root directory.
overwrite	A logical value. If TRUE, overwrite an existing workflow.

Details

Workflow triggers can be modified. See Events that trigger workflows.

Value

Invisible. This function is called for its side effects.

See Also

Keep ‘CITATION.cff’ up to date: cff_git_hook

Examples

## Not run: 
cff_gha_update()

## End(Not run)

cffr documentation built on Aug. 24, 2026, 5:11 p.m.