[TIP] 깃허브 labels, 조금만 쉽게 설정하기

깃허브 labels, 조금만 쉽게 설정해보자

 

 

0. 들어가며

안녕하세요〰 오늘은 코드가 아닌 TIP을 들고왔습니다. 바로 깃허브(GitHub)에서 Issue나 Pull request를 생성할 때 사용하는 라벨(labels)에 관한 내용입니다. 우리는 개인 프로젝트를 할 때나 팀 프로젝트를 할 때 이슈 구분 · 역할 구분 · 내용 구분 등을 정확하게 위해서 라벨이라는 것을 사용합니다.

 

이름표 정도로 생각하면 편하겠죠? 특히나 팀 개발을 할 때에는 더욱 유용하게 사용이 되죠. 이것이 어떤 것을 구현한건지 누가 구현한건지 한 번에 알아볼 수 있는 용도로도 사용이 됩니다. 평소에 우리는 이러한 라벨을 필요에 맞게 수정하고 추가하고 하는데요.

 

매번 새롭게 라벨을 설정하는 것도 이제는 지겹고 힘이 듭니다... 이러한 불편함을 조금은 해소하고자 오늘의 팁을 들고 왔습니다. label을 지정해 둔 형식으로 한 번에 업데이트 하는 방법을 혹시 알고 계셨나요?

 

👀오늘은 깃허브 라벨(label)을 한 번에 업데이트 하는 방법을 알아보려고 합니다.

 

그 동안 label을 수작업으로 하나씩 생성하셨다면 그 수고를 조금은 덜 수 있는 시간이 되지 않을까 싶네요.

 

 

---

 

1. 스크린샷

결과 화면을 이렇게 만들어보도록 하겠습니다.

깃허브 Issue, PR에 사용할 Labels

 

 

---

 

2. 진행과정

STEP 1. 준비물을 준비해주세요.

우리가 준비할 준비물은 2가지입니다.

✅ labels.json 파일

✅ 깃허브 personal access token

 

1. labels.json 파일 준비하기

아래 labels.json 파일을 labels.json 파일로 저장해주고, 우리의 Desktop(데스크탑) 디렉터리로 옮겨줍니다. (경로 같은 경우는 아무데나 상관없지만 편의상 Desktop 디렉터리로 진행하겠습니다.)

[
  {
    "name": "Assignee1",
    "color": "d5ecc2",
    "description": "담당자1"
  },
  {
    "name": "Assignee2",
    "color": "ffd3b4",
    "description": "담당자2"
  },
  {
    "name": "Assignee3",
    "color": "dbe6fd", 
    "description": "담당자3"
  },
  {
    "name": "bug",
    "color": "ee0701",
    "description": "버그입니다."
  },
  {
    "name": "chore",
    "color": "8c001a",
    "description": "세팅 관련입니다."
  },
  {
    "name": "cleanup",
    "color": "fef2c0",
    "description": "코드를 더 깔끔하게 만들기만 하고, 코드 작동 방식이나 출력에 대한 부분을 변경하지 않습니다."
  },
  {
    "name": "docs",
    "color": "d4c5f9",
    "description": "문서만 변경됩니다."
  },
  {
    "name": "feat",
    "color": "84b6eb",
    "description": "구현·개선 사항에 관련된 내용입니다."
  },
  {
    "name": "fix",
    "color": "de5b7b",
    "description": "버그를 수정합니다."
  },
  {
    "name": "help wanted",
    "color": "0e8a16",
    "description": "누구나 처리할 수 있는 이슈를 나타냅니다."
  },
  {
    "name": "question",
    "color": "cc317c",
    "description": "질문만 있는 이슈, 질문이 해결되면 이슈를 종료합니다."
  },
  {
    "name": "refactoring",
    "color": "fbca04",
    "description": "코드가 내부적으로 작동하는 방식을 변경합니다. cleanup과는 다릅니다."
  },
  {
    "name": "test",
    "color": "bfe5bf",
    "description": "테스트 코드만 변경됩니다."
  }
]

다음과 같이 labels.json을 데스크탑 디렉터리에 위치시켜주세요.

 

 

2. personal access token 준비하기

다음 링크(GitHub/Settings/Developer settings)로 접속해주세요.

바로가기 링크 : https://github.com/settings/apps

GitHub: Where the world builds software

 

 

 

Personal access tokens 버튼을 클릭해주세요.

다음과 같은 토큰 발급 화면을 만날 수 있어요 :-)

 

 

Generate new token를 클릭해주세요.

• Note : 목적에 맞게 이름을 적어주세요. (아무거나 적어도 됩니다.)
• repo 카테고리를 ✅체크박스 On 해주세요!

 

 

 

token 을 발급받았다면 copy해서 잘 가지고 있어주세요. (곧 사용할 예정입니다.)

 

 

---

 

STEP 2. labels.json 적용하기

위에서 준비물 2가지(json, token)를 잘 준비했다면 이제 우리는 사용하기만 하면 됩니다.

 

 

1️⃣ 먼저, desktop(데스크탑) 디렉터리로 이동해주세요. 거기에 json을 다운받았으니까요!

cd desktop

 

2️⃣ 아래 명령어를 입력해서 라벨을 업데이트 합니다. (token이랑 repository 이름을 정확히 입력해주세요!!)

 

npx github-label-sync --access-token {본인의 token} --labels ./labels.json {라벨을 업데이트하고 싶은 본인의 레포지터리}

npx github-label-sync --access-token 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 --labels ./labels.json 29th-WE-SOPT-iOS-Part/KimTaeHyeon

빨간 박스 주의해서 작성하기 (본인에 맞게 작성하기)

 

 

---

 

 

3. 결과화면

지금은 이미 만들어진 기본 틀을 사용해서 이런식으로 나오지만, 본인이 자주 사용하는 라벨(이름, 색상, 설명)을 미리 만들어놓으면 편하겠죠? 세팅을 바꾸고 싶으면 위에서 다운받았던 json을 수정해서 사용하면 됩니다.

 

해당 값을 본인에게 맞게 수정하고 사용하시면 됩니다.

 

 

색상 코드 참고할 수 있는 페이지도 첨부할게요.

Color Palettes for Designers and Artists - Color Hunt

Color Palettes for Designers and Artists - Color Hunt

 

---

 

4. 마무리

도움이 조금 되셨을까요? 반복되는 작업을 줄이는 것이 개발자의 임무라면 우리는 오늘 그 임무를 하나 달성했네요 .. ㅎㅎ 레포마다, 프로젝트마다 매번 새롭게 라벨을 만들기 귀찮다면 위의 방법을 사용하세요.. 이상 라벨 세팅하기 편이었습니다💥