create_github_labels: Create GitHub labels for issues and PR from CSV file

In fmichonneau/carpenter: Tools to work with The Carpentries GitHub repositories

Create GitHub labels for issues and PR from CSV file

Description

Create, from a CSV file, labels for issues and pull requests on GitHub.

Usage

create_github_labels(label_csv, owner, repo, delete_previous = FALSE)

Arguments

label_csv	the path to the CSV file with the labels. It should have the following columns: type, label, color, description, long_description.
owner	the owner of the GitHub repository
repo	the name of the GitHub repository where to create the labels
delete_previous	should already existing labels in the repository be deleted? (boolean)

Details

If delete_previous is set to TRUE, any label that were present in the repository (and that do not match one of the labels specified in the CSV file) will be deleted.

Labels that already exists (with the same name as the one provided in the CSV file) will be updated to match the specification of the spreadsheet.

The CSV file is expected to have the following columns:

• print_order: order in which the labels should be displayed (used by document_github_labels()).

• type: label type. Used to categorize the tags.

• label: the name to be used for the label.

• color: the hexadecimal value for the background color of the label.

• prefix: boolean (TRUE/FALSE) to indicate whether the content of the type column should be used as a prefix for the label. If type is status, label is in progress, and prefix is TRUE, then the label will appear as status: in progress on GitHub.

• description: the short description that will be displayed on GitHub next to the label.

• long description: a long description to be used by document_github_labels().

An example of the CSV file is available on the Carpentries handbook repository.

Value

TRUE invisibly

fmichonneau/carpenter documentation built on July 5, 2022, 7:08 a.m.