new_build: Trigger a New Build on Circle CI

View source: R/general.R

new_buildR Documentation

Trigger a New Build on Circle CI

Description

Triggers a new build for a specific repo branch.

Usage

new_build(
  repo = github_info()$name,
  user = github_info()$owner$login,
  vcs_type = "gh",
  branch = "master",
  quiet = FALSE
)

Arguments

repo

⁠[character]⁠
The repository slug to use. Must follow the "user/repo" structure.

user

⁠[character]⁠
The username for the repository. By default queried using get_user().

vcs_type

⁠[character]⁠
The version control system to use. Defaults to "gh" (Github).

branch

A character string specifying the repository branch.

quiet

⁠[logical]⁠
If TRUE, console output is suppressed.

Details

Trigger a new Circle CI build for a specific repo branch.

Value

An object of class circle_api with the following elements

  • content (queried content)

  • path (API request)

  • response (HTTP response information)

See Also

retry_workflow()

Examples

## Not run: 
new_build()

## End(Not run)

pat-s/circle documentation built on Oct. 6, 2023, 2:30 a.m.