add_labels: Add or remove labels from an issue or pull request

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

add_labels() adds labels to an existing issue or pull request within a GitHub repository. remove_labels() removes labels from an issue or pull request.

Usage

add_labels(labels, issue, repo, ...)

remove_labels(labels, issue, repo, ...)

Arguments

labels	(character) The name of the labels.
issue	(string or character) The number or title of the issue.
repo	(string) The repository specified in the format: owner/repo.
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/issues#add-labels-to-an-issue

• https://docs.github.com/en/rest/reference/issues#remove-a-label-from-an-issue

Value

add_labels() returns a tibble of the added labels properties. remove_labels() returns a tibble of the remaining labels properties.

Label Properties:

• name: The name of the label.

• color: The color of the label in hexidecimal code.

• description: The description of the label.

Examples

## Not run: 

  add_labels(
    labels = c("feature", "new-label"),
    issue  = "Test issue",
    repo   = "ChadGoymer/githapi"
  )

  remove_labels(
    labels = c("feature", "new-label"),
    issue  = "Test issue",
    repo   = "ChadGoymer/githapi"
  )


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.