Github Label 이란?

  • Github label은 issue 와 pull request에서 카테고리를 분류하기 위한 이름표 라고 생각하시면 됩니다.

  • 처음 git repository를 생성하게 되면 label은 아래와 같이 기본적으로 9개의 label 들을 제공합니다.
  1. 상단 탭의 issues 클릭
  2. labels 버튼 클릭

Github Label 사용

  • Issues 작업을 진행할 때 협업하는 사람끼리 각 Issues 에 대해 어떤 작업인지 명확하게 표시하기 위해 사용합니다.
  • Issues 작업에서 Label을 기반으로 필터링 하여 검색할 수 있습니다.

  • Pull requests에서 Label을 기반으로 필터링 하여 검색할 수 있습니다.

Github Label 한번에 적용하는 법

환경

  • windows 10

1. lables.json 파일 준비하기

  • name: 라벨 이름, 이모지 포함 가능
  • coler: Hex 값으로 색상 지정 가능
  • description: 설명, 라벨 설명 지정 가능
[
  {
    "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...)"
  }
]

2. npm 설치

npm 설치 사이트로 이동하기 를 클릭하여 download 페이지로 이동해 주세요.

위 그림에서 자신의 환경에 맞는 npm을 설치하시면 됩니다.

3. Github access token 준비하기

해당 링크를 클릭하여 Github access token 발급하기 로 접속하여 access tokens 를 발급 받습니다.

  • Note: token 이름입니다. 각자의 목적에 맞게 작성해주시면 됩니다.
  • repo 카테고리를 체크 해주세요!

4. github-label-sync 설치

npm install -g github-label-sync

5. repository 적용

github-label-sync --access-token [액세스 토큰] --labels labels.json [계정명]/[저장소 이름]

예를 들어 액세스 토큰: abcd, 계정명: test, 저장소 이름: testRepo 라면

github-label-sync --access-token abcd --labels labels.json test/testRepo

Github에 label 한번에 적용하기 결과

  • label.json 에 입력한 label 들이 모두 적용 되었다.
  • 기존 label 들은 삭제 되니 주의!

반응형

+ Recent posts