{"Package":"circle","Title":"R Client Package for Circle CI","Version":"0.7.3","Authors@R":"c(\nperson(\"Patrick\", \"Schratz\", , \"patrick.schratz@gmail.com\", role = c(\"aut\", \"cre\"),\ncomment = c(ORCID = \"0000-0003-0748-6624\")),\nperson(\"Max\", \"Joseph\", role = \"rev\",\ncomment = \"Max reviewed the package for ropensci, see \"),\nperson(\"Sharla\", \"Gelfand\", role = \"rev\",\ncomment = \"Sharla reviewed the package for ropensci, see \")\n)","Description":"Tools for interacting with the 'Circle CI' API\n(). Besides executing common tasks\nsuch as querying build logs and restarting builds, this package also\nhelps setting up permissions to deploy from builds.","License":"GPL-3","URL":"https://docs.ropensci.org/circle/,\nhttps://github.com/ropensci/circle","BugReports":"https://github.com/ropensci/circle/issues","Imports":"cli (>= 2.0.0), gh, httr, jsonlite","Suggests":"clipr, covr, gert, knitr, openssl, purrr, rmarkdown, testthat\n(>= 3.0.0), usethis (>= 2.0.0), utils, vcr, withr","VignetteBuilder":"knitr","Config/testthat/edition":"3","Config/testthat/parallel":"true","Encoding":"UTF-8","RoxygenNote":"7.3.2","NeedsCompilation":"no","Packaged":"2024-07-31 18:59:25 UTC; pjs","Author":"Patrick Schratz [aut, cre] (),\nMax Joseph [rev] (Max reviewed the package for ropensci, see\n),\nSharla Gelfand [rev] (Sharla reviewed the package for ropensci, see\n)","Maintainer":"Patrick Schratz ","Repository":"CRAN","Date/Publication":"2024-07-31 19:30:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/circle_0.7.3.tar.gz","jsonAuthors":[{"name":"Patrick Schratz","email":"patrick.schratz@gmail.com","maintainer":true},{"name":"Max Joseph","email":null,"maintainer":false},{"name":"Sharla Gelfand","email":null,"maintainer":false}],"readme":"\n\n[![tic](https://github.com/ropensci/circle/workflows/tic/badge.svg?branch=main)](https://github.com/ropensci/circle/actions)\n[![CircleCI](https://img.shields.io/circleci/build/gh/ropensci/circle/main?label=Linux&logo=circle&logoColor=green&style=flat-square)](https://app.circleci.com/pipelines/github/ropensci/circle)\n[![CRAN Status](https://www.r-pkg.org/badges/version-ago/circle)](https://cran.r-project.org/package=circle)\n[![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html)\n[![](https://badges.ropensci.org/356_status.svg)](https://github.com/ropensci/software-review/issues/356)\n\n\n\n# circle\n\nR client package for the Continuous Integration (CI) provider 'Circle CI'.\n[Circle CI](https://circleci.com/) stands in line with [GitHub Actions](https://github.com/features/actions), [Travis CI](https://www.travis-ci.com/), [AppVeyor](https://ci.appveyor.com/login) and many more CI providers.\n[Circle CI](https://circleci.com/) heavily relies on Docker containers for runner execution.\n\nContinuous Integration (CI) / Continuous Deployment (CD) is heavily used in the IT world to automatically perform certain actions after a specific trigger (e.g. after each commit).\nWhen developing R packages the most common uses cases are to check the package on each commit for CRAN eligibility (by running `R CMD Check`) and to deploy a [{pkgdown}](https://github.com/r-lib/pkgdown) documentation page for the package.\n\nThis package aims help to set up CI/CD with the service provider [Circle CI](https://circleci.com/) and provides R functions to execute CI specific tasks such as build restarts, log queries or setting environment variables from within R.\nIt also simplifies the setup process for build deployments via [`use_circle_deploy()`](https://docs.ropensci.org/circle/reference/use_circle_deploy.html).\nAll functionality relies on calls to the [Circle CI REST API](https://circleci.com/docs/api/v2/#circleci-api).\n\nThere are two ways to use this package:\n\n- Via the high-level functions of this package which wrap common API calls:\n - `get_pipelines()`\n - `get_checkout_keys()`\n - `set_env_var()`\n - etc.\n- Via direct API calls through the workhorse function [`circle()`](https://docs.ropensci.org/circle/reference/circle.html).\n\n{circle} does not come with an option to setup Circle CI YAML files.\nPlease see the related [{tic}](https://github.com/ropensci/tic) package for such functionality and more CI workflow related tools.\n{circle} aims to provide a handy and flexible high-level interface to the [Circle CI API](https://circleci.com/docs/api/v2/) without shipping opinionated workflow functionality.\n\n## API versions\n\nAll functionality uses the Circle CI [API v2](https://github.com/CircleCI-Archived/api-preview-docs) which follows the **pipelines** -> **workflows** -> **jobs** approach.\nThis API version is still in beta and might undergo some changes in the near future.\n\nSome functions/endpoints can also be used via API versions v1.1 and v1 by setting the `api_version` argument.\nHowever, this will only work if the respective API endpoint is available for the chosen API version.\nUsually, there should be no need in practice to fall back to API version < 2.\n\nFor more information on the differences between the [Circle CI API](https://circleci.com/docs/api/v2/) versions, have a look at the [document explaining changes between v1.1 and v2](https://github.com/CircleCI-Archived/api-preview-docs/blob/master/docs/api-changes.md).\n\n## Installation\n\nDevelopment Version:\n\n```r\nremotes::install_github(\"ropensci/circle\")\n```\n\n## Get Started\n\nSee the [Getting Started](https://ropensci.github.io/circle/articles/circle.html) vignette for an introduction.\n\n## Note to Developers\n\nThis packages relies on private API keys for local testing.\nSee [CONTRIBUTING.md#testing-the-package](https://github.com/ropensci/circle/blob/main/.github/CONTRIBUTING.md#testing-the-package) for detailed instructions.\n\n# Acknowledgments\n\nThis package was inspired by the work of [Thomas J. Leeper](https://github.com/leeper) on the (discontinued) [cloudyr/circleci](https://github.com/cloudyr/circleci) package and by the (archived) [ropenscilabs/travis](https://github.com/ropensci-archive/travis) package.","jobInfo":{"package":"circle","version":"0.7.3","parsingStatus":"success","parserVersion":2,"parsedAt":"2024-07-31T22:29:48+0000"}}

Description

Usage

Arguments

Value