update_label: Update a label in a repository

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

Description

This function updates a label for the specified repository in GitHub. It can be used to change name, color or description.

Usage

update_label(label, repo, name, color, description, ...)

Arguments

label	(string) The name of the label.
repo	(string) The repository specified in the format: owner/repo.
name	(string, optional) The name of the label.
color	(string, optional) Either the color name (see grDevices::colors()) or a hexidecimal color code (see color-hex.com).
description	(string, optional) A description of the label.
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/issues#update-a-label

Value

update_label() returns a list of the label 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: 

  update_label(
    label       = "new-label",
    repo        = "ChadGoymer/githapi",
    name        = "updated-label",
    color       = "green",
    description = "This is an updated label"
  )


## End(Not run)

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