list_builds: List builds

In cloudyr/circleci: Circle CI API Client Package

Description

Retrieve a list of Circle CI project builds (among those available to the user) or for a specific project. Pagination paramaters allow one to retrieve all builds for a user or for a specific project.

Usage

list_builds(project = NULL, user = NULL, limit = 30, offset = 0, ...)

Arguments

project	A character string specifying the project name, or an object of class “circle_project”. If the latter, there is no need to specify user. If NULL, all builds for all user projects are returned.
user	A character string specifying the user name. This is not required if project is of class “circle_project”.
limit	An integer specifying the number of builds to return, with a maximum of 100.
offset	An integer used as a paging parameter.
...	Additional arguments passed to an HTTP request function, such as GET, via circleHTTP.

Details

Retrieves a very detailed list of projects and project-related information for all Circle CI projects attached to the current user.

Value

A list of class “circle_builds”, wherein each element is a “circle_build”.

See Also

get_build, list_projects

Examples

## Not run: 
# list most recent 5 builds across all projects
list_builds(limit = 5)

# list first 10 and next 10 builds
list_builds(limit = 10)
list_builds(limit = 10, offset = 10)

# list builds for a specific project
list_builds(list_projects[[1]])

## End(Not run)

cloudyr/circleci documentation built on May 13, 2019, 8:20 p.m.