Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clok/ghlabels
Simple CLI tool to help manage labels across repos
https://github.com/clok/ghlabels
cli github github-labels go golang labels sync
Last synced: 3 months ago
JSON representation
Simple CLI tool to help manage labels across repos
- Host: GitHub
- URL: https://github.com/clok/ghlabels
- Owner: clok
- License: mit
- Created: 2021-04-14T02:33:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T23:12:00.000Z (3 months ago)
- Last Synced: 2024-10-26T11:40:24.213Z (3 months ago)
- Topics: cli, github, github-labels, go, golang, labels, sync
- Language: Go
- Homepage: https://clok.sh/ghlabels/
- Size: 87.9 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ghlabels
[](https://github.com/clok/ghlabels/blob/master/LICENSE)
[](https://goreportcard.com/report/clok/ghlabels)
[](https://coveralls.io/github/clok/ghlabels)
[](https://pkg.go.dev/github.com/clok/ghlabels?tab=overview)
Simple CLI tool to help manage labels across repos
> Please see [the docs for details on the commands.](./docs/ghlabels.md)
```text
$ bin/ghlabels
NAME:
ghlabels - label sync for repos and organizations
USAGE:
ghlabels [global options] command [command options] [arguments...]
COMMANDS:
sync sync labels - rename, sync, delete
config commands for viewing or generating configuration
stats prints out repository stats
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)
```
- [Documentation](./docs/ghlabels.md)
- [Configuration](#configuration)
- [Configuration Schema](#configuration-schema)
- [Installation](#installation)
- [Homebrew](#homebrewhttpsbrewsh-for-macos-users)
- [curl binary](#curl-binary)
- [docker](#dockerhttpswwwdockercom)
- [Wishlist](#wishlist)
- [Development](#development)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
## Configuration
To view the default configuration, run the `ghlabels config defaults` command.
```text
$ ghlabels config 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](https://brew.sh) (for macOS users)
```
brew tap clok/ghlabels
brew install ghlabels
```
### curl binary
```
$ curl https://i.jpillora.com/clok/ghlabels! | bash
```
### [docker](https://www.docker.com/)
The compiled docker images are maintained
on [GitHub Container Registry (ghcr.io)](https://github.com/orgs/clok/packages/container/package/ghlabels). 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](https://github.com/clok/ghlabels/releases)
- `x.y.z` (versions): Images that are build from the tagged versions within GitHub.
```bash
docker pull ghcr.io/clok/ghlabels
docker run -v "$PWD":/workdir ghcr.io/clok/ghlabels --version
```
## Wishlist
GitHub doesn't support accessing the Organization Repository Defaults via their API
(found here: `https://github.com/organizations//settings/repository-defaults`)
I would love to add commands that would allow:
1. Generating a configuration based the Organization default settings.
1. Sync the Organization defaults to Repos within it.
1. Update the default settings based on a configuration manifest.
Unfortunately, the GitHub API does not support interacting with the Organization Repository Defaults, so these items
have to remain on the wishlist for now. Please see
the [GitHub REST API Discussion thread](https://github.com/github/rest-api-description/discussions/329) that I opened to
request this feature.
## Development
1. Fork the [clok/ghlabels](https://github.com/clok/ghlabels) repo
1. Use `go >= 1.16`
1. Branch & Code
1. Run linters :broom: `golangci-lint run`
- The project uses [golangci-lint](https://golangci-lint.run/usage/install/#local-installation)
1. Commit with a Conventional Commit
1. Open a PR
## Versioning
We employ [git-chglog](https://github.com/git-chglog/git-chglog) to manage the [CHANGELOG.md](CHANGELOG.md). For the
versions available, see the [tags on this repository](https://github.com/clok/ghlabels/tags).
## Authors
* **Derek Smith** - [@clok](https://github.com/clok)
See also the list of [contributors](https://github.com/clok/ghlabels/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details