記憶より記録を 📝
記憶より記録を 📝/
github labelを一度に適用する方法
github labelを一度に適用する方法
メインカテゴリー
github labelを一度に適用する方法
github labelを一度に適用する方法

github labelを一度に適用する方法

작성자
ユミンユミン
카테고리
Dev.Log
작성일
2023년 07월 06일
태그
Github
notion image
 
Githubのissueを作成する時、既存のlabelでは個人的に直観性が悪く、どんな状況でどんなlabelを使うのがいいのかよく分からないので、個人的に修正して使っています。そうすると、新しいリポジトリを作る時、毎回設定をする必要がある問題が発生します。これを毎回一つずつ直接適用するのはとても非効率的なことです...！開発者なら当然、繰り返しを嫌うし、自動化するもの😎 私が使ってるlabelテンプレートを共有して、リポジトリに直接適用する方法についてまとめてみたいと思います。

✅ Github Label

  • github labelはissueとpull requestでカテゴリを分類するための名前タグとして使われます。
      • notion image
  • githubでは基本的に9つのLabelsを提供しています。Labels(9)をクリックすると下記のように確認することができます。
      • notion image

✅ Github Labelを適用する

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

github labelを同期できるライブラリがありました。 npmでインストールしてみましょう。
npm install -g github-label-sync

2. access-token 準備

リポジトリにlabelを適用するにはaccess-tokenが必要です。トークンを生成することは本ポストでは説明しません。

3. label.json 設定

新しく適用するlabel configファイル、labels.jsonを定義する必要があります。labelのname, color, description, aliasesを定義することができ、JSONとYAMLの両方が可能です。上で紹介したカスタムlabelのconfigファイルは次のようになります。それぞれ好きな色や名前を変更して使うことができます。
[
  {
    "name": "⚙ Setting",
    "color": "e3dede",
    "description": "개발 환경 세팅"
  },
  {
    "name": "✨ Feature",
    "color": "a2eeef",
    "description": "기능 개발"
  },
  {
    "name": "🌏 Deploy",
    "color": "C2E0C6",
    "description": "배포 관련"
  },
  {
    "name": "🎨 Html&css",
    "color": "FEF2C0",
    "description": "마크업 & 스타일링"
  },
  {
    "name": "🐞 BugFix",
    "color": "d73a4a",
    "description": "Something isn't working"
  },
  {
    "name": "💻 CrossBrowsing",
    "color": "C5DEF5",
    "description": "브라우저 호환성"
  },
  {
    "name": "📃 Docs",
    "color": "1D76DB",
    "description": "문서 작성 및 수정 (README.md 등)"
  },
  {
    "name": "📬 API",
    "color": "D4C5F9",
    "description": "서버 API 통신"
  },
  {
    "name": "🔨 Refactor",
    "color": "f29a4e",
    "description": "코드 리팩토링"
  },
  {
    "name": "🙋‍♂️ Question",
    "color": "9ED447",
    "description": "Further information is requested"
  },
  {
    "name": "🥰 Accessibility",
    "color": "facfcf",
    "description": "웹접근성 관련"
  },
  {
    "name": "✅ Test",
    "color": "ccffc4",
    "description": "test 관련(storybook, jest...)"
  }
]

4. リポジトリに適用

access-tokenとlabels.jsonファイルが準備されたら、下記のコマンドでレポジトリに適用することができます。labels.jsonがあるフォルダで実行します。
github-label-sync --access-token [access-token] --labels labels.json [account]/[repository]
 
このjsonファイルをgithubにアップしました。必要な方はリンクを確認してください！ 🙂

댓글

guest