unquietcode / standard-issue

script to initialize a GitHub repository with a standard set of issue labels

Standard Issue

Creates, updates, and optionally removes labels from your GitHub repository's issue tracker to match a predefined configuration file. This makes it easy to set up a new repository, or match an existing repository, with your preferred issue labels.

Set Up

Install Dependencies

gem install json
gem install octokit

or with bundler

bundle install

Configure Labels File

You must create a JSON file mapping label names to their colors. The name of the file should be labels.json or else you can change the expected file name in the script configuration section.

Names are case sensitive in the labels file by default. This means that if you capitalize a name in your JSON file, but the name is lowercase on GitHub, the label will be updated to match. You can set the SKIP_EXISTING flag to skip updates to names and colors for labels which exist already.

Configure Script

The top of the script contains a configuration section listing the various configuration options. By default, the script operates in "dry run" mode which makes no API requests, and this can be disabled by setting the configuration flag.

Run Script

ruby run.rb

standard-issue's Issues

support label descriptions

Since label descriptions are now supported by GitHub, update the script and input file format to support descriptions for labels.

This is a breaking change to be included in a future version, unless some backwards compatibility is added (such as distinguishing between flat values and complex object values).

accept username, password, and API key from a credentials file

Allow the GitHub username, password, and API key to be passed in via a credentials file. Add to .gitgnore.

accept repository name from command line

Allow the repository name to be passed in via the command line arguments.

Update GitHub API to v4

When the V3 API is officially deprecated, migrate to the new V4 GraphQL API, which will require some decent changes.