Githubのラベルをgithub-label-setupを使って管理する
概要
https://github.com/azu/github-label-setup を利用する事でGithubのラベルの管理をjsonファイルで行うことができる。
これによりGithubのラベル設定を各プロジェクトごとに手動で行う必要がなくなり、どのリポジトリでもラベルを合わせることができる。
注意点
以下はラベル設定jsonファイルを作る時に留意したいことです。
- 既にissueに設定されているラベルを上書き修正したい場合はaliasesを使って置き換える必要があります。基本的には全てのラベルを消してjsonファイルに設定されているラベルを登録します
使い方
以下はWindowsのWSL環境で行っています。yarnが既にインストールされている事を前提とします。
github-label-setup のインストール
グローバルインストールが楽だと思いますがお好みで。
$ yarn global add @azu/github-label-setup
yarn global binのPathを通す
人によってはPathが通っておらず github-label-setup
が見つからないかもしれないので記載しておきます。
$yarn global bin
で出力されるPathを確認後 $ vi ~/.bashrc
に export PATH="{ここに確認したパス}:$PATH"
を記載してください。(bash_profile
などに記載でも大丈夫だとは思います)
GithubでTokenを生成
ラベルを操作するためのTokenを生成してください。
権限は repo
だけあれば十分です。
https://github.com/settings/tokens
ラベルのjsonファイルを作成
jsonファイル以外でも作成できます。以下のフォーマットで記載する必要があります。
https://github.com/Financial-Times/github-label-sync#label-config-file
コマンドを打つ
事前に dry-run をすることをおすすめします。
$ github-label-setup --dry-run --token "{先程作ったToken}" --labels {ラベルを設定したjsonまでのPath} myname/myrepo
jsonを作成したフォルダなどで以下を叩けば適用完了です。
$ github-label-setup --token "{先程作ったToken}" --labels {ラベルを設定したjsonまでのPath} myname/myrepo