【GitHub】ラベルを一斉に変える方法

はじめに

※6月23日に投稿予定でしたが、GitHub Actions のコードを変更したことで投稿できていなかったので、まとめて投稿します

こんにちは。アメリカ在住で独学エンジニアを目指している Taira です。
現在 railsでアプリ開発中ですが開発に苦戦しながら進めています。
開発だけならまだ何とかがんばれるのですが、PR もわかりずらい、どこまでをbranch として開発を進めればいいのか等、開発手法についてかなりあいまいに進めてきていました。

一生一人で開発するならまだしも、これからチームに入って開発することを考えるとこの現状を打破しなければと思い、手探りで調べてみました。

すると、どうやらissue や label, projects を積極的に活用する必要があり、恥ずかしながら今までどのように活用するのか知りませんでした。

• ラベルの一斉変更
• issues のテンプレートの作成
• Pull request のテンプレートの作成
• projects の活用

上記の4つの活用により、かなり開発がしやすくなるしほかの人とも共同で開発しやすくなることが判明しました。

まずは、ラベルの一斉変更の方法を記事にしようと思います

作成したいラベルの作成

まずはラベルの作成をします。
json ファイルでも作成できるようですが、私は慣れているyml で以下のように作成しました

# .github/labels.yml
- name: bug
  color: "d73a4a"
  description: バグ報告

- name: feature
  color: "a2eeef"
  description: 新機能の提案

- name: documentation
  color: "0075ca"
  description: ドキュメントの新規作成・改善

- name: test
  color: "e4e669"
  description: テストコード関連

- name: refactor
  color: "cfd3d7"
  description: リファクタリング目的

- name: infra
  color: "0e8a16"
  description: CI/CDに関わる環境構築やインフラ設定（例：Docker、AWS、VPC、セキュリティグループなど）

- name: ci/cd
  color: "a295d6"
  description: GitHub Actionsや自動テスト、デプロイフローなどCI/CDに関するIssue

- name: "priority: high"
  color: "b60205"
  description: 最優先で対応すべき課題

- name: "status: in progress"
  color: "fbca04"
  description: 現在対応中のIssue

- name: frontend
  color: "1d76db"
  description: フロントエンド関連

- name: backend
  color: "5319e7"
  description: バックエンド関連

後でGitHub上で変更できるのでそこまで神経質に作成しなくてもよさそうです。

変更方法

GitHub Actionsを利用する方法もあるようですが、私は github-label-syncを使用しました。

1. github-label-syncをインストールする

npm install -g github-label-sync

1. 同期（上書き）する

github-label-sync --access-token YOUR_GITHUB_TOKEN --labels .github/labels.yml YOUR_USER/REPO_NAME

• --access-token：GitHubのPAT(Personal Access Token) です。作成方法は以下の記事がわかりやすいと思います

• --labels：ラベル定義ファイル（.yml or .json）

これで変更できていると思います。GitHub 上の変更したレポジトリのラベルを確認してみてください