ghlabels

README

ghlabels

Simple CLI tool to help manage labels across repos

Please see the docs for details on the commands.

$ bin/ghlabels 
NAME:
   ghlabels - label sync for repos and organizations

USAGE:
   ghlabels [global options] command [command options] [arguments...]

COMMANDS:
   sync             sync labels - delete, rename, update
   dump-defaults    print default labels yaml to STDOUT
   stats            prints out repo stats
   install-manpage  Generate and install man page
   help, h          Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help (default: false)
   --version, -v  print the version (default: false)

Configuration

To view the default configuration, run the dump-defaults command.

$ ghlabels dump-defaults

The order of operations is:

1. Rename
2. Sync
3. Delete

A custom configuration file can be provided using the --config, -c flag. The file passed to this config option must use the following structure. You do not need to have all 3 Top Level sections in the config file for the configuration to be valid.

By default, the --config, -c flag will overwrite the default configuration. You can merge the provided configuration with the default using the --merge-with-defaults, -m boolean flag. This will take the default configuration and merge in the user provided configuration, with the user config taking precedence.

Configuration Schema

Top Level	Type	Description	Structure
rename	List	List of Label names to rename from a given name to a new name.	{ from: "string", to: "string" }
remove	List	List of Labels to be deleted from a Repo.	string
sync	List	List of Label configuration that will be used to create or update a given Label.	{ name: "string", color: "sting", description: "string" }

Installation

Homebrew (for macOS users)

brew tap clok/ghlabels
brew install ghlabels

curl binary

$ curl https://i.jpillora.com/clok/ghlabels! | bash

docker

The compiled docker images are maintained on GitHub Container Registry (ghcr.io). We maintain the following tags:

• edge: Image that is build from the current HEAD of the main line branch.
• latest: Image that is built from the latest released version
• x.y.z (versions): Images that are build from the tagged versions within GitHub.

docker pull ghcr.io/clok/ghlabels
docker run -v "$PWD":/workdir ghcr.io/clok/ghlabels --version

Development

1. Fork the clok/ghlabels repo
2. Use go >= 1.16
3. Branch & Code
4. Run linters 🧹 golangci-lint run
   • The project uses golangci-lint
5. Commit with a Conventional Commit
6. Open a PR

Versioning

We employ git-chglog to manage the CHANGELOG.md. For the versions available, see the tags on this repository.

Authors

• Derek Smith - @clok

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details