create_label: Create an issue label in a repository

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

Description

This function creates a new label for issues and pull requests for the specified repository in GitHub. It can also be used to set the colour and description.

Usage

create_label(name, repo, description, color = random_color(), ...)

Arguments

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

Details

For more details see the GitHub API documentation:

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

Value

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

  create_label(
    name        = "new-label",
    repo        = "ChadGoymer/githapi",
    color       = "blue",
    description = "This is a detailed label"
  )


## End(Not run)

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