@azu/github-label-setup

Opinionated GitHub label setup tool.

Create starter GitHub labels
Migrate existing labels
No configuration - It is opinionated

Install

Install with npm:

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

Usage

This tool works without any configuration.

Usage
  $ github-label-setup --token xxx

Options

  -h, --help                  [Boolean] output usage information
  -l, --labels <path>         [Path:String] the path to look for the label configuration in. Default: labels.json
  --token <token>             [String] a GitHub access token (also settable with a GITHUB_ACCESS_TOKEN environment variable)
  -d, --dry-run               [Boolean] calculate the required label changes but do not apply them
  -A, --allow-added-labels    [Boolean] allow additional labels in the repo, and don't delete 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 a wrapper of github-label-sync.

Financial-Times/github-label-sync: Synchronise your GitHub labels with as few destructive operations as possible

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

These are opinionated labels.

duplicate - This issue or Pull Request already exists
help wanted - Extra attention is needed
good first issue - Good for newcomers
Priority: Critical
Priority: High
Priority: Medium
Priority: Low
Status: Abandoned - The issue or Pull Request is wontfix
Status: Blocked - Progress on the issue is Blocked
Status: In Progress - Work in Progress
Status: Proposal - Request for comments
Status: PR Welcome - Welcome to Pull Request
Status: Review Needed - Request for review comments
Status: Need More Info - Lacks enough info to make progress
Type: Breaking Change - Includes breaking changes
Type: Bug - Bug or Bug fixes
Type: Documentation - Documentation only changes
Type: Feature - New Feature
Type: Refactoring - A code change that neither fixes a bug nor adds a feature
Type: Testing - Adding missing tests or correcting existing tests
Type: Maintenance - Repository Maintenance
Type: CI - Changes to CI configuration files and scripts
Type: Question - Further information is requested
Type: Security - Vulnerability disclosure or Fixing security issue
Type: Dependencies - Dependency issues or Changes to dependency files

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.

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

fusion94/github-label-setup