📦 Setup GitHub label without configuration.
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
img
src
test
.babelrc initial commit May 15, 2017
.gitignore
.travis.yml
LICENSE
README.md Rename: good for beginner -> good first issue Oct 11, 2017
labels.json
package.json
yarn.lock

README.md

@azu/github-label-setup

Opinionated GitHub label setup tool.

demo

  • Create starter GitHub labels
  • Migrate exists labels
  • No configuration

Install

Install with npm:

npm install @azu/github-label-setup -g

Usage

This tool work without no configuration.

Usage
  $ github-label-setup --token xxx

Options

  -h, --help                  output usage information
  -l, --labels <path>         the path or npm packages name to look for the label configuration in. Default: labels.json
  --token <token>  a GitHub access token (also settable with a GITHUB_ACCESS_TOKEN environment variable)
  -d, --dry-run               calculate the required label changes but do not apply them

You'll also need a GitHub access token ready so that the the tool will have access to your repositories. You can generate an access token here, be sure to allow the "repo" scope.

This tool is wrapper of github-label-sync.

Npm packages for labels

labels can be set requireable path like npm packages.

$ github-label-setup --token xxx --labels @owner/github-label-presets

See Label JSON format.

Default Labels

That is opinionated labels.

demo

  • duplicate
    • Duplicated issue
  • help wanted
    • help/need idea issue
  • good first issue
  • Priority: Critical
  • Priority: High
  • Priority: Low
  • Priority: Medium
  • Status: Abandoned
  • Status: Blocked
  • Status: In Progress
  • Status: Proposal
  • Status: Ready for PR
  • Status: Review Needed
  • Type: Breaking Change
  • Type: Bug
  • Type: Feature
  • Type: Documentation
  • Type: Refactoring
  • Type: Maintenance
  • Type: Question"

Related

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu