cancel_build: Cancel build

Description Usage Arguments Details Value See Also Examples

View source: R/endpoints.R

Description

Cancel a Circle CI build.

Usage

1
cancel_build(build, project, user, ...)

Arguments

build

A character string specifying the project name, or an object of class “circle_build”. If the latter, there is no need to specify project or user.

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.

user

A character string specifying the user name. This is not required if build is of class “circle_build” and/or if project is of class “circle_project” .

...

Additional arguments passed to an HTTP request function, such as GET, via circleHTTP.

Details

Cancel a Circle CI build.

Value

A list of class “circle_build”.

See Also

new_build, retry_build

Examples

1
2
3
4
5
## Not run: 
b <- retry_build(list_builds(limit = 1)[[1]])
cancel_build(b)

## End(Not run)

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