GitHub Actions setup and badges
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:
Run 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 .Rbuildignore.
Provides the markdown to insert a badge into your README.
use_github_actions() use_github_actions_badge(name = "R-CMD-check", repo_spec = NULL)
name |
Specifies the workflow whose status the badge will report. This
is the |
repo_spec |
Optional GitHub repo specification in this form: |
use_github_actions()Configures a basic R CMD check workflow on GitHub Actions by adding a
standard R-CMD-check.yaml file to the .github/workflows directory of the
active project.
use_github_actions_badge()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
tidyverse packages.
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.