github_actions

use_github_actions

use_github_actions_badge

Specifies the workflow whose status the badge will report. This
is the <code>name</code> keyword that appears in the workflow <code>.yaml</code> file.

name

Optional GitHub repo specification in this form: <code>owner/repo</code>. This can usually be inferred from the GitHub remotes of active project.

repo_spec

Sets up continuous integration (CI) for an R package that is developed on
GitHub using <a href="https://github.com/features/actions">GitHub Actions</a>. CI can be
used to trigger various operations for each push or pull request, such as:<ul>
<li>Run <code>R CMD check</code> on various operating systems and R versions</li>
<li>Build and deploy a pkgdown site</li>
<li>Determine test coverage</li>
</ul>This family of functions<ul>
<li>Adds the necessary configuration files and lists them in <code>.Rbuildignore</code>.</li>
<li>Provides the markdown to insert a badge into your README.</li>
</ul>

Automate package and project setup tasks that are
otherwise performed manually. This includes setting up unit testing,
test coverage, continuous integration, Git, 'GitHub', licenses,
'Rcpp', 'RStudio' projects, and more.

Jennifer Bryan

usethis

Automate Package and Project Setup

Hadley Wickham

RStudio 

github_actions function

Configures a basic <code>R CMD check</code> workflow on GitHub Actions by adding a
standard <code>R-CMD-check.yaml</code> file to the <code>.github/workflows</code> directory of the
active project.

<code>use_github_actions()</code>

Generates a GitHub Actions badge and that's all. It does not configure a
workflow.

github_actions: GitHub Actions setup and badges

Description

Usage

Arguments

<code>use_github_actions()</code>

<code>use_github_actions_badge()</code>

See Also