[GitHub] GitHub Labels 커스텀 한 번에 등록하기(설정 환경 : mac)

🤔 프로젝트 진행 시 빠지지 않는 Issue/PR의 Labels..! 종류도 많아서 매번 하나씩 등록하는 건 너무 번거롭다는 생각이 들었다. 분명히 편하게 등록할 수 있는 방법이 있을 거라는 생각이 들어 찾아보니 역시나 존재하는구나~.~ 방법을 알아보자!
✅ (24.04.30 추가) 윈도우 환경에서도 문제없이 동작하는 것을 확인하였습니다.

 

1. 결과물 미리보기

아래 사진처럼 7개의 라벨을 등록해 보자. 

 

2. Labels 작업하기

label 데이터는 json 파일로 관리한다. label.json이라는 파일을 만들어줄 건데, 이때 파일의 위치는 중요하지 않지만 추후 업로드 편의를 위해 desktop 위치에 파일을 저장했다.

 

label을 한 번에 저장하기 위해 작성해줘야 하는 양식은 아래와 같다.

json 양식

[
  {
    "name": "라벨명",
    "color": "컬러코드(#제외)",
    "description": "라벨 설명"
  }
  // ...
]

• 주의할 점은 color에는 #을 제외한 숫자만 넣어줘야 한다.

예제 적용 코드

👾 예제에 적용한 코드

[
  {
    "name": "👾 Bug",
    "color": "e99695",
    "description": "버그 관련"
  },
  {
    "name": "🌎 Deploy",
    "color": "c5def5",
    "description": "배포"
  },
  {
    "name": "🎨 Design",
    "color": "efeeb3",
    "description": "마크업 및 스타일링"
  },
  {
    "name": "📑 Docs",
    "color": "bfdadd",
    "description": "문서 작성 및 수정"
  },
  {
    "name": "✨ Feature",
    "color": "e2caf4",
    "description": "기능 구현"
  },
  {
    "name": "🛠️ Refactor",
    "color": "c2e0c6",
    "description": "코드 리팩토링"
  },
  {
    "name": "⚙️ Setting",
    "color": "e2e2e2",
    "description": "개발 환경 세팅"
  }
]

 

3.개인 액세스 토큰 발급

label.json 파일이 완성됐다면 이제 깃허브에 접근하기 위한 개인 액세스 토큰을 발급받아야 한다.

액세스 토큰 설정 메뉴를 찾아가는 방법은 다음과 같다.

1. 본인 깃허브 계정의 Settings 메뉴 클릭
2. 왼쪽 사이드바 마지막 메뉴에 있는 </> Developer Settings 클릭
3. 왼쪽 사이드바에 있는 Personal access tokens 토글 메뉴에서 원하는 생성 방식 클릭

 

나는 토큰 생성 버전을 classic으로 발급받았는데, 이유는 새로운 생성 버전은 날짜로만 기한을 정할 수 있길래 그냥 옵션 자체로 기한을 무제한으로 설정할 수 있는 classic 버전을 선택했다. 무제한 설정 방법은 Expiration의 옵션을 No expiration으로 설정해 주면 된다.

 

⚠️ 액세스 토큰 발급 시에 생성된 코드는 생성 당시에만 확인할 수 있으니 잊지 말고 메모장에 저장해 두자.

repo만 체크했다.

 

4. 깃허브 레포지토리에 label.json 파일 등록

마지막 관문! label.json 파일과 깃허브 액세스 토큰까지 준비가 되었다면 이제 등록을 진행해줘야 한다. 사용하고 있는 노트북이 맥북이기에 터미널을 열어서 label.json 파일이 저장되어 있는 경로로 이동한다. (desktop에 저장해 뒀기에 desktop으로 이동!)

 

그리고 아래 명령어 양식에 따라 본인에게 해당되는 내용을 추가하여 작성해 준다.

npx github-label-sync --access-token [액세스토큰] --labels ./labels.json [계정아이디]/[레포명]

• 개인 개정의 레포지토리에 연결할 거라면 본인 깃허브 아이디(username으로 지정해 둔 이름)/저장소이름을 넣으면 되고 organization이라면 팀명/저장소이름을 적어준다.
  
  • 계정아이디/레포명 순으로 적지 않으면 제대로 등록이 진행되지 않으니 양식을 꼭 지켜줘야 한다.

아래와 같이 화면 결과가 나왔다면 성공이다.

깃허브 레포지토리에 가서 Labels가 제대로 등록됐는지 반드시 확인하길 바란다.

---

참고

[블로그] Github Label, Issue, Pull Request Template 적용하기 - modolee(링크)

 

💬 본 포스팅은 공부 기록용으로 정확하지 않은 정보가 존재할 수 있습니다. 발견하신다면 알려주세요!