Git Notes: Git의 가장 멋지고 미움받는 기능 (2022)

카테고리

프로그래밍/소프트웨어 개발

서브카테고리

개발 툴

대상자

소프트웨어 개발자 및 버전 관리 도구 사용자, 중간 난이도

핵심 요약

• git notes 는 커밋 메시지 변경 없이 보충 정보를 추가할 수 있는 강력한 기능
• 코드 리뷰, 테스트 결과, 트레일러 등 메타데이터 저장에 활용 가능
• GitHub 등 호스팅 서비스에서 지원 부족으로 실제 사용이 제한적

섹션별 세부 요약

1. git notes 기능 소개

• 메타데이터 추가 기능으로, 커밋, 블롭, 트리 오브젝트에 정보를 덧붙일 수 있음
• 커밋 메시지 수정 없이 추가 정보 저장 가능
• 예시 명령어: git notes add -m 'Acked-by: <이메일>'

2. 활용 사례 및 예시

• 커밋별 작업 시간 추적, 리뷰 및 테스트 결과 저장
• Gerrit의 reviewnotes 플러그인은 리뷰자 및 테스트 실행 내역을 notes로 표시
• Google의 git-appraise는 분산 코드 리뷰 기능을 git notes로 구현

3. 사용성 및 제한 사항

• 인터페이스 불편 및 인지도 낮음으로 인해 사용률 저조
• GitHub은 2014년 이후 notes 노출 중단으로 더욱 사용 기회 감소
• 블롭이나 트리에 notes 추가 시 git 내부 구조 이해 필요

4. 트레일러 기능 및 비슷한 도구

• Git 트레일러는 key-value 형태로 메타데이터 추가 가능
• PostgreSQL의 COMMENT 기능은 데이터베이스 객체에 텍스트 추가 가능
• Forgejo는 트레일러 기능 지원 시작

5. 실무 적용 및 의견

• 내부 코드 리뷰 기록을 커밋 메시지 대신 저장하여 검색 및 추적 용이
• notes는 커밋 이후 추가 정보 필요 시 유용
• GitHub에서 notes 지원 요청 및 더 나은 UI 필요성 강조

결론

• git notes는 커밋 메시지 수정 없이 메타데이터 추가가 가능하나, 인터페이스 및 호스팅 서비스 지원 부족으로 사용이 제한적
• 트레일러 기능은 메타데이터 추가에 더 적합한 것으로 보임
• GitHub과 같은 호스팅 서비스에서 notes 지원 확대가 필요하며, UI 개선이 실무 적용에 도움이 될 수 있음