https://github.com/rdohms/github-label-syncer
Allows automated management of GitHub labels
https://github.com/rdohms/github-label-syncer
github github-labels hacktoberfest
Last synced: about 2 months ago
JSON representation
Allows automated management of GitHub labels
- Host: GitHub
- URL: https://github.com/rdohms/github-label-syncer
- Owner: rdohms
- License: mit
- Created: 2019-01-04T21:05:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T19:38:17.000Z (about 1 year ago)
- Last Synced: 2024-05-02T01:14:35.859Z (about 1 year ago)
- Topics: github, github-labels, hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 800 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# GitHub Label Syncer
The goal of this project is to make it simple for a standard set of labels to be included in every github project. Based on a configuration file it automatically creates, replaces, removes and updates existing libraries to match the desired output.
# Usage
## CLI
This library can be run from the command line, with a few parameters and a configuration file.
To see detailed instructions run:
`$ ./cli.js -h`
Example off a call:
`$ ./cli.js -t XXXX -c mock/sample.config.json rdohms/my-repo`
## Via code
```js
const GithubLabelSyncer = require('./github-label-syncer');
const syncer = new GithubLabelSyncer();
const operations = syncer.run(
repository,
token,
labelConfiguration,
dryRun
);
```
# Configuration
This an example configuration file:
```json
{
"labels": [{
"name": "BC-break",
"replaces": [],
"color": "6a1993",
"description": "This issue or pull request breaks backwards compatibility"
}, {
"name": "Bug",
"replaces": ["fault", "defect"],
"color": "b60205",
"description": "Something isn't working"
}]
}
```