개발일지/GIT

[Git] github label 한번에 추가하기 (github-label-sync)

양쏘쏘 2024. 5. 30. 13:00
728x90
반응형

깃허브에 label을 json파일로 한 번에 관리하고 등록하는 방법입니다. 

Github label 예시

 

github-label-sync 라이브러리를 사용하는 방법입니다

node.js 12+에서 동작이 가능하므로 node가 없는 경우 설치 후 아래를 따라가면 됩니다.

 

1. github-label-sync 설치

npm i github-label-sync

 

2. labels.json 파일 생성

[
  { "name": "☑ feature", "color": "1D76DB", "description": "새로운 기능 추가" },

  { "name": "⚙️ config", "color": "fcdd74", "description": "설정 파일 추가" },
  {
    "name": "✅ test",
    "color": "ccffc4",
    "description": "테스트(테스트 코드 추가, 수정, 삭제, 비즈니스 로직에 변경이 없는 경우)"
  },

  {
    "name": "✨ clean up",
    "color": "a2eeef",
    "description": "비즈니스 로직에 변경이 없고 코드 수정을 하는 경우"
  },
  {
    "name": "🎨 design",
    "color": "FEF2C0",
    "description": "CSS 등 사용자 UI 디자인 변경"
  },
  {
    "name": "🏷️ rename",
    "color": "f7d26d",
    "description": "파일이나 디렉토리의 이름만 수정하는 경우"
  },
  { "name": "🐞 fix", "color": "d73a4a", "description": "버그 수정 또는 typo" },
  { "name": "📃 docs", "color": "C5DEF5", "description": "문서 작업만 수행하는 경우" },

  {
    "name": "📝 comment",
    "color": "008672",
    "description": "필요한 주석 추가 및 변경"
  },

  {
    "name": "🔨 refactor",
    "color": "f29a4e",
    "description": "코드를 리팩토링하는 경우"
  },

  {
    "name": "🗑️ remove",
    "color": "5e7291",
    "description": "파일을 삭제하는 작업만 수행하는 경우"
  },
  {
    "name": "🙋‍♂️ question",
    "color": "08C1F6",
    "description": "질문이 있는 경우"
  },
  { "name": "🚨 conflict", "color": "D93F0B", "description": "충돌 해결 내용" },
  {
    "name": "🧾 chore",
    "color": "fd7dff",
    "description": "위에 걸리지 않는 기타 변경사항(빌드 스크립트 수정, assets image, 패키지 매니저 등)"
  }
]

 

3. github에 label 추가

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