Superseded by http://github.com/apps/settings
Label management (create/rename/update/delete) on Github as code.
- Using GitHub?
- Want to commit/copy/share your label configuration?
- Use
labeler
!
For FOSS maintainers, enable your users to submit PRs and improve the process/label system!
- Clean up your labels.
- Move labels out of the same flat space.
- Enforce a label color scheme that is not meaningless nor confusing to view.
Inspired by infrastructure as code tools like Terraform and organized label systems in projects like these:
- https://github.com/kubernetes/kubernetes/labels
- https://github.com/coreos/etcd/labels
- https://github.com/coreos/rkt/labels
- https://github.com/spf13/hugo/labels
- https://github.com/docker/docker/labels
Get binaries for OS X / Linux / Windows from the latest release.
Or use go get
:
go get -u github.com/tonglil/labeler
First, set a GitHub token in the environment (optional, the token can be set as an cli argument as well).
export GITHUB_TOKEN=xxx
- The token for public repos need the
public_repo
scope.- The token for private repos need the
repo
scope.
To scan existing labels from a repository and save it to a file:
labeler scan labels.yaml --repo owner/name
Which when run against a "new" repo created on GitHub, will:
- Fetch
bug
with colorfc2929
- Fetch
duplicate
with colorcccccc
- Fetch
enhancement
with color84b6eb
- Fetch
invalid
with colore6e6e6
- Fetch
question
with colorcc317c
- Fetch
wontfix
with colorffffff
And write them into labels.yaml
, creating the file if it doesn't exist, otherwise overwriting its contents.
To apply labels to a repository:
labeler apply labels.yaml --dryrun
Where labels.yaml
is like:
repo: owner/name
labels:
- name: bug
color: fc2929
- name: help wanted
color: 000000
- name: fix
color: cccccc
from: wontfix
- name: notes
color: fbca04
Which when run against a "new" repo created on GitHub, will:
- Rename
wontfix
tofix
with colorffffff
toffffff
- Update
help wanted
with color159818
to000000
- Create
notes
with colorfbca04
- Delete
duplicate
with colorcccccc
- Delete
enhancement
with color84b6eb
- Delete
invalid
with colore6e6e6
- Delete
question
with colorcc317c
When run again, rename changes will not be run because the label already exists. In this manner, this tool is idempotent.
$ labeler
Labeler is a CLI application for managing labels on Github as code.
With the ability to scan and apply label changes, repository maintainers can
empower contributors to submit PRs and improve the project management
process/label system!
Usage:
labeler [command]
Available Commands:
apply Apply a YAML label definition file
completion Output shell completion code for tab completion
scan Save a repository's labels into a YAML definition file
version Print the version information
Use "labeler [command] --help" for more information about a command.
source <(labeler completion)
glide
is used to manage vendor dependencies.
Roadmap:
- Plan -> execute (aka always dry-run first).
- Automatically update file after renaming operations are complete.
- Organizational support (apply/only-add one config to all repos in an organization).
This could use your contribution! Help me create a runnable test suite.