Continuous integration setup and badgesSource:
These functions are not actively used by the tidyverse team, and may not currently work. Use at your own risk.
Sets up third-party continuous integration (CI) services for an R package on GitLab or CircleCI. These functions:
Add service-specific configuration files and add them to
Activate a service or give the user a detailed prompt.
Provide the markdown to insert a badge into README.
use_circleci(browse = rlang::is_interactive(), image = "rocker/verse:latest")
use_circleci_badge(repo_spec = NULL)
Open a browser window to enable automatic builds for the package.
The Docker image to use for build. Must be available on DockerHub. The rocker/verse image includes TeXLive, pandoc, and the tidyverse packages. For a minimal image, try rocker/r-ver. To specify a version of R, change the tag from
latestto the version you want, e.g.
Optional GitHub repo specification in this form:
owner/repo. This can usually be inferred from the GitHub remotes of active project.
Adds a basic
.gitlab-ci.yml to the top-level directory of a package. This
is a configuration file for the GitLab CI/CD continuous integration service.
Adds a basic
.circleci/config.yml to the top-level directory of a package.
This is a configuration file for the CircleCI
continuous integration service.
Only adds the Circle CI badge. Use for a project where Circle CI is already configured.