정리/Git

[Git] Github label 커스텀

민발자 2024. 5. 13. 17:26
728x90

https://docs.github.com/ko/issues/using-labels-and-milestones-to-track-work/managing-labels

 

레이블 관리 - GitHub Docs

레이블을 만들고, 편집하고, 적용하고, 삭제하여 문제, 끌어오기 요청 및 토론을 분류할 수 있습니다.

docs.github.com

 

1️⃣ 기본 라벨

리포지토리에서 Pull request → labels를 클릭하면 확인할 수 있다.

 

 

📌 기본으로 제공되는 라벨 종류

bug 예기치 않은 문제 또는 의도하지 않은 동작
documentation 설명서 개선 또는 추가가 필요함
duplicate 유사한 이슈, 끌어오기 요청 또는 토론
enhancement 새 기능 요청
good first issue 최초 기여자에게 적절한 이슈
help wanted 유지 관리자가 이슈 또는 끌어오기 요청에 대한 지원을 원함
invalid 이슈, 끌어오기 요처 또는 토론이 더 이상 관련 없음
question 이슈, 끌어오기 요청 또는 토론에 더 많은 정보가 필요함
wontfix 이슈, 끌어오기 요청 또는 토론에 대한 작업이 계속 되지 않음

 

 

2️⃣ label 커스텀하기

📃 labels.json 파일 생성

필요한 라벨을 JSON Array 형태로 정의

[
  {
    "name": "⚙️ Setting",
    "color": "e3dede",
    "description": "개발 환경 세팅"
  },
  {
    "name": "✨ Feature",
    "color": "a2eeef",
    "description": "기능 개발"
  },
  {
    "name": "🌏 Deploy",
    "color": "C2E0C6",
    "description": "배포 관련"
  },
  {
    "name": "🎨 Style",
    "color": "FEF2C0",
    "description": "마크업 & 스타일링"
  },
  {
    "name": "🐞 BugFix",
    "color": "d73a4a",
    "description": "Something isn't working"
  },
  {
    "name": "📃 Docs",
    "color": "1D76DB",
    "description": "문서 작성 및 수정"
  },
  {
    "name": "🔨 Refactor",
    "color": "f29a4e",
    "description": "코드 리팩토링"
  },
  {
    "name": "✅ Test",
    "color": "ccffc4",
    "description": "test 관련"
  }
]

🔎 참고

https://velog.io/@rimo09/Github-github-label-%ED%95%9C%EB%B2%88%EC%97%90-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0

 

 

📌 토큰 생성

https://github.com/settings/apps

 

GitHub: Let’s build from here

GitHub is where over 100 million developers shape the future of software, together. Contribute to the open source community, manage your Git repositories, review code like a pro, track bugs and fea...

github.com

 

 

📌 github-label-sync로 적용하기

https://github.com/Financial-Times/github-label-sync#configuration

 

GitHub - Financial-Times/github-label-sync: Synchronise your GitHub labels with as few destructive operations as possible

Synchronise your GitHub labels with as few destructive operations as possible - Financial-Times/github-label-sync

github.com

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

 

📌 확인

 

728x90