The label synchronisation utilises a CI pipeline (label_maker.yml) that runs every hour to look out for any new repositories and apply the labels.
- Install go, if you don't have it installed. Click here for directions.
- Clone the repo
$ GO111MODULE=off go get github.com/k8-proxy/github-labeller- Edit the file labels.json with the labels you want synchronised. eg
{
"name": "QA Task",
"description": "Quality Assurance needed",
"color": "c2e0c6"
},
{
"name": "merge conflict",
"description": "Indicates a merge conflict.",
"color": "fbca04"
},- Implement the changes
$ GITHUB_TOKEN=mytoken github-labeller ORGANISATIONwhere "mytoken" is your personal github token, "ORGANISATION" is the organisation to which the repos belong.
- You'll need Node.js 12+ installed to run GitHub Label Sync. You'll also need a GitHub access token ready so that the the tool will have access to your repositories.
$ npm install -g github-label-sync- Download labels.yml into the working directory
$ github-label-sync --access-token xxxxxx --labels labels.yml myname/myrepoNote: Running this will delete all labels not in the yml file.
| Label | Description |
|---|---|
| bug | Something isn't working |
| documentation | Improvements or additions to documentation |
| duplicate | This issue or pull request already exists |
| enhancement | New feature or request |
| good first issue | Good for newcomers |
| help wanted | Extra attention is needed |
| invalid | This doesn't seem right |
| question | Further information is requested |
| wontfix | This will not be worked on |
| Label | Description |
|---|---|
| A1 Injection | |
| A2 Broken Authentication | |
| A6 Sensitive Data Exposure | |
| A11 DoS | |
| ci | |
| Changes requested | Indicates that some modifications needs to be implemented |
| Jupyter Notebook | Indicates a local Jupyter Notebook |
| Merge Conflict | Indicates a merge conflict |
| New Feature | |
| P0 | |
| P1 | |
| P2 | |
| P3 | |
| PR | |
| QA task | |
| Quality | |
| Refactor | |
| Research | |
| Ready for review | |
| Risk - Accepted | |
| Risk - Fixed | |
| Risk - High | |
| Risk - Low | |
| Risk - Medium | |
| Risk - To accept | |
| Risk - To fix | |
| Security | |
| Test Needed | |
| Use case |