Skip to content
R client package for the Circle CI API
R
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci install rotemplate in before_deply() Dec 31, 2019
.github update CONTRIBUTING.md Jan 22, 2020
R fix endpoint leftover in `browse_circle_token()`, fixes #7 Feb 4, 2020
inst initial commit Sep 29, 2015
man-roxygen fix env var functions, add test Dec 27, 2019
man
pkgdown
tests sapply -> vapply Jan 22, 2020
vignettes
.Rbuildignore
.gitignore
.lintr lint and style package Dec 27, 2019
.pre-commit-config.yaml add codemeta hook again Jan 8, 2020
.travis.yml
DESCRIPTION use {withr} in tests Jan 17, 2020
LICENSE.md
NAMESPACE export set_env_var() Jan 13, 2020
NEWS.md Bump version to 0.5.0.9001 Jan 13, 2020
README.Rmd upd wording Jan 22, 2020
README.md upd wording Jan 22, 2020
appveyor.yml
circle.Rproj
codecov.yml
codemeta.json
tic.R

README.md

Build Status CircleCI AppVeyor build status codecov Lifecycle: maturing rOpenSci footer

circle

R client package for the Circle CI REST API

This package aims to execute tasks such as build restarts, log queries or setting environment variables for the CI service provider Circlei CI from within R. It also simplifies the setup process for build deployments via use_circle_deploy().

{circle} does not come with an option to setup Circle CI YAML files. Please see the related {tic} package for such functionality.

API versions

All functionality uses the Circle CI API v2 which follows the pipelines -> workflows -> jobs approach. This API version is still in beta and might undergo some changes in the near future.

Some functions can also be used via API versions v1.1 and v1 via the api_version argument. However, this will only work if the respective endpoints are available for both API versions. Usually, there should be no need in practice to fall back to API version < 2.

If you want to get more information, have a look at the document explaining changes between v1.1 and v2.

Installation

Development Version:

remotes::install_github("ropenscilabs/circle")

Get Started

See the Getting Started vignette for an introduction.

Note to developers

This packages relies on using API keys to test its functionality. Please have a look at section “Testing the package” for more information.

Acknowledgments

This package was inspired by the work of Thomas J. Leeper on the (discontinued) cloudyr/circleci package and by the ropenscilabs/travis package.

You can’t perform that action at this time.