https://github.com/scrum/git-update-repos-labels

A tiny helper to update of label in the github repository
https://github.com/scrum/git-update-repos-labels

Last synced: 4 months ago
JSON representation

A tiny helper to update of label in the github repository

• Host: GitHub
• URL: https://github.com/scrum/git-update-repos-labels
• Owner: Scrum
• Created: 2019-08-05T09:46:06.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-01T17:02:44.000Z (over 3 years ago)
• Last Synced: 2025-10-13T08:45:56.914Z (9 months ago)
• Language: TypeScript
• Size: 970 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# git-update-repos-labels

> A tiny helper to update of label in the github repository 

[![Travis Build Status](https://img.shields.io/travis/Scrum/git-update-repos-labels/master.svg?style=flat-square&label=unix)](https://travis-ci.org/Scrum/git-update-repos-labels)[![Coveralls status](https://img.shields.io/coveralls/Scrum/git-update-repos-labels.svg?style=flat-square)](https://coveralls.io/r/Scrum/git-update-repos-labels)

## Install

```bash

npm install git-update-repos-labels

```

## Usage

```js

import gitUpdateReposLabels from 'git-update-repos-labels';

const token = '59bd8d5eb1980b7f926f2d106f4f2f0312fdf97f';

const label = {

  id: 'MDU6TGFiZWwxNDg1MjAwMjk2', 

  color: 'ededed', 

  name: 'status: in progress', 

  description: null

};

gitUpdateReposLabels({label, token});

//=> {id: "MDU6TGFiZWwxNDg1MjAwMjk2", "name": "status: in progress", "color": "ededed", "description": null}

```

## API

#### `label`

Type: `object` **`Required`**  

Default: `undefined`  

Description: *label creation options `{id: string, name: string, color: string, description: string}` when `{id, name, color}` are required*

#### `token`

Type: `String` **`Required`**  

Default: `undefined`  

Description: *You  Github Personal Token. Grab it from your [Developer settings](https://github.com/settings/developers)*

## Recommend

 - [git-get-repos-labels](https://github.com/Scrum/git-get-repos-labels) -  A iny helper to get a list of labels from the github repository