github_actions

use_github_actions

use_github_actions_badge

The name to give to the <a href="https://github.com/features/actions">GitHub Actions</a> workflow.

name

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>. These functions<ul>
<li>Add the necessary configuration files and place them in <code>.Rbuildignore</code>.</li>
<li>Provide 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

Adds a basic <code>R-CMD-check.yaml</code> file to the <code>.github/workflows</code> directory of a
package. This is a configuration file for the <a href="https://github.com/features/actions">GitHub Actions</a> service.

<code>use_github_actions()</code>

Only adds the <a href="https://github.com/features/actions">GitHub Actions</a> badge. Use for a project
where GitHub Actions is already configured.

<code>use_github_actions_badge()</code>

The name to give to the <a href='https://github.com/features/actions'>GitHub Actions</a> workflow.

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>. These functions<ul>
<li>Add the necessary configuration files and place them in <code>.Rbuildignore</code>.</li>
<li>Provide the markdown to insert a badge into your README</li>
</ul>

github_actions: GitHub Actions setup and badges

Description

Usage

Arguments

<code>use_github_actions()</code>

<code>use_github_actions_badge()</code>

See Also