Sets up continuous integration (CI) for an R package that is developed on GitHub using GitHub Actions. CI can be used to trigger various operations for each push or pull request, such as:
R CMD check on various operating systems and R versions
Build and deploy a pkgdown site
Determine test coverage
This family of functions
Adds the necessary configuration files and lists them in
Provides the markdown to insert a badge into your README.
1 2 3
Specifies the workflow whose status the badge will report. This
Optional GitHub repo specification in this form:
Configures a basic
R CMD check workflow on GitHub Actions by adding a
R-CMD-check.yaml file to the
.github/workflows directory of the
Generates a GitHub Actions badge and that's all. It does not configure a workflow.
use_github_action() sets up specific, individual actions, e.g. test
coverage or pkgdown build and deploy.
use_tidy_github_actions() sets up the standard GitHub Actions used for
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.