cff_gha_update

This function installs a
<a href="https://github.com/features/actions">GitHub Actions</a> workflow in your
repository. The workflow
updates your <code>CITATION.cff</code> when any of these events occur:<ul>
<li>You publish a new release of the package.</li>
<li>Your <code>DESCRIPTION</code> or <code>inst/CITATION</code> file is modified.</li>
<li>The workflow can be run manually.</li>
</ul>

Citation File Format ('CFF') version 1.2.0
<doi:10.5281/zenodo.5171937> is a human- and machine-readable file
format for software citation metadata. Core utilities generate, read,
write and validate Citation File Format metadata for 'R' packages.

Diego Hernang<c3><b3>mez

cffr

Generate Citation File Format ('CFF') Metadata

Diego Hernangómez

João Martins

Scott Chamberlain

cff_gha_update function

<dl><dt>path</dt>
<dd>Project root directory.</dd>
<dt>overwrite</dt>
<dd>A logical value. If <code>TRUE</code>, overwrite an existing workflow.</dd></dl>

Arguments

This function installs a
<a href='https://github.com/features/actions'>GitHub Actions</a> workflow in your
repository. The workflow
updates your <code>CITATION.cff</code> when any of these events occur:<ul>
<li>You publish a new release of the package.</li>
<li>Your <code>DESCRIPTION</code> or <code>inst/CITATION</code> file is modified.</li>
<li>The workflow can be run manually.</li>
</ul>

Install a cffr GitHub Actions workflow — cff_gha_update

<dl>

<dt>path</dt>
<dd>Project root directory.</dd>


<dt>overwrite</dt>
<dd>A logical value. If <code>TRUE</code>, overwrite an existing workflow.</dd>

</dl>

cff_gha_update: Install a cffr GitHub Actions workflow

Description

Usage

Value

Arguments

Details

See Also

Examples