Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.31 KB

README.md

File metadata and controls

51 lines (37 loc) · 1.31 KB
Raw

github-label

Synchronize your github labels between repositories.

Usage

First, generate an access token here, and allow the repo scope. Then,

# clone the repository
git clone [email protected]:MaintainX/mx-iterable.git

# install dependencies
yarn

You can start the program like this:

Usage: yarn <mode> <owner>/<repository> [options]

Arguments:
  mode                        the mode of the program, one of: "import", "export", "reset"
  owner/repository            the owner and repository name, e.g. "ptessier/github-label"

Options:
  -a, --access-token <token>  a GitHub access token (or a GITHUB_ACCESS_TOKEN environment variable)
  -d, --dry-run               calculate the required label changes without applying the changes
  -f, --file <path>           (default: labels.json) the path of the label configuration in
  -A, --allow-extra-labels    allow extra labels in the repo, otherwise they will be deleted

Modes

  • import import your label to the repository from the labels.json file
  • export export the labels to the labels.json file
  • reset reset the labels of the repository

Format

Labels are defined in a JSON array

[
  {
    "name": "name",
    "color": "ff0000",
    "description": "optional description"
  }
]