xorima/github-label-manager repository overview

⁠Github-label-manager

This application is designed to manage the labels in your github repository from a source of truth repository.

A good usecase for this is if you want a standardised all your labels across a given repository topic, of cookbook, label definitions are collected from json files inside the source of truth repository

⁠User Permissions

• It is recommended to use a github bot account when using this application
• You must ensure the account has permissions to create branches and pull requests directly on the repository, it will not try to fork.
• You must also supply a GITHUB_TOKEN to access the github api server with.

⁠Items of Note

Github has a rate limiter, do not run this script continously you will get rate limited and then the script will fail

⁠Configuration

Below are a list of variables, what they mean and example values

⁠Label declaration

Each label must be declared inside a seperate file in the source repository/path combo.

Example file

name: help-wanted.json

{
  "name": "help wanted",
  "color": "#008672",
  "description": "Extra attention is needed"
}

Examples for all the default label declarations can be found inside label-definitions in this repository

⁠Docker Tags

This application is tagged as follows

While all updates should result in a release this is not always the case, sometimes master will change for non-functional related changes and a release will not be made, eg a new file in the infrastructure folder