Movatterモバイル変換

circle

R client package for the Continuous Integration (CI) provider ‘CircleCI’.Circle CI stands in line withGitHub Actions,Travis CI,AppVeyor and many more CIproviders.Circle CI heavily relieson Docker containers for runner execution.

Continuous Integration (CI) / Continuous Deployment (CD) is heavilyused in the IT world to automatically perform certain actions after aspecific trigger (e.g. after each commit). When developing R packagesthe most common uses cases are to check the package on each commit forCRAN eligibility (by runningR CMD Check) and to deploy a{pkgdown} documentationpage for the package.

This package aims help to set up CI/CD with the service providerCircle CI and provides R functions toexecute CI specific tasks such as build restarts, log queries or settingenvironment variables from within R. It also simplifies the setupprocess for build deployments viause_circle_deploy().All functionality relies on calls to theCircle CI RESTAPI.

There are two ways to use this package:

• Via the high-level functions of this package which wrap common APIcalls:
  • get_pipelines()
  • get_checkout_keys()
  • set_env_var()
  • etc.
• Via direct API calls through the workhorse functioncircle().

{circle} does not come with an option to setup Circle CI YAML files.Please see the related{tic} package for suchfunctionality and more CI workflow related tools. {circle} aims toprovide a handy and flexible high-level interface to theCircle CI API withoutshipping opinionated workflow functionality.

API versions

All functionality uses the Circle CIAPI v2which follows thepipelines ->workflows ->jobs approach. ThisAPI version is still in beta and might undergo some changes in the nearfuture.

Some functions/endpoints can also be used via API versions v1.1 andv1 by setting theapi_version argument. However, this willonly work if the respective API endpoint is available for the chosen APIversion. Usually, there should be no need in practice to fall back toAPI version < 2.

For more information on the differences between theCircle CI API versions,have a look at thedocumentexplaining changes between v1.1 and v2.

Installation

Development Version:

remotes::install_github("ropensci/circle")

Get Started

See theGettingStarted vignette for an introduction.

Note to Developers

This packages relies on private API keys for local testing. SeeCONTRIBUTING.md#testing-the-packagefor detailed instructions.

Acknowledgments

This package was inspired by the work ofThomas J. Leeper on the(discontinued)cloudyr/circleci packageand by the (archived)ropenscilabs/travispackage.