[Git] git commit message template 적용하기

이전 포스팅(https://kkangsg.tistory.com/95)에서 commit message convention에 대해 알아보았다.

 

이번 포스팅에서는

해당 convention을 따르는 Git commit message template 전체를 살펴보고

global과 local에 적용해서 앞으로 나의 프로젝트에 commit message template을 적용하도록 하겠다.🧚

 

---

1. commit message template 소개

나는 아래와 같은 커밋 메시지 템플릿을 사용하고 있다. Gitmoji를 사용하고 참고해야할 부분들을 추가로 적어주었다.

(템플릿의 내용이 왜 이렇게 구성되었는지 알고 싶다면 이전 포스팅(convention)에 대해 참고하면 된다)

 

################
# <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성
# 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지
# 예) :sparkles:Feat : 로그인 기능 추가 # 이슈번호

# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)

################
# 본문(구체적인 내용)을 아랫줄에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
# '왜'라는 것에 초점을 맞춰 작성

################
# 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등)
# 해결 -> Closes(종료), Fixes(수정), Resolves(해결)
# 참고 -> Ref(참고), Related to(관련), See also(참고)
# 예) Close #7

################
# :tada:Init: 프로젝트 개시
# :sparkles:Feat : 새로운 기능 추가
# :bug:Fix : 버그 수정
# :fire:Remove : 코드 삭제
# :memo:Docs : 문서 수정
# :white_check_mark:Test : 테스트 코드, 리팩토링 테스트 코드 추가
# :recycle:Refact : 코드 리팩토링
# :rocket:Deploy : 배포
# :hammer:Chore : 빌드 업무 수정, 패키지 매니저 수정
################

:tada:, :sparkles: 등 이 의미하는 바는 emoji이다.

 

2.  .gitmessage 파일 만들기

템플릿 파일을 만드는 방법은 크게 2가지가 있다.

 

1️⃣ VSC 같은 에디터 안에서 직접 txt 파일을 생성하고 위의 template 내용을 복붙한다.

 

2️⃣ bash shell에서 vi 또는 vim 편집기를 이용해서 만든다.

 

step1) 원하는 디렉토리 위치로 이동한다.

cd /path/user/project

 

step2) vi 편집기로 만들고자 하는 파일을 연다 (해당 파일이 없어도 열 수 있다 = 임시생성)

vi .gitmessage

 

(파일명 뒤에 .txt 확장자 이름은 선택이다. 일반적으로 붙여주는 것 같은데 나는 안 붙여줬다.)

 

step3) vi 편집기가 열리면 'i'키를 눌러서 '텍스트 입력 모드'로 변경한 후, 위의 template 내용을 입력한다. (복붙한다)

 

step4) 입력이 완료되면 'esc'를 눌러서 텍스트 입력 모드가 아닌 뷰어 모드로 전환해주고, ':wq'를 입력해서 저장 및 종료해준다.

 

 

 

3. git commit template 시스템 설정하기

 

원래는 $ git commit -m "writing commit message" 해당 명령어를 통해 커밋메시지를 작성했다면

이제는

$ git config [optional] commit.template [path of template]

 

위와 같은 명령어를 통해 

$ git commit 명령어를 까지만 작성해도, 우리가 만든 'commit message tamplate 전문'이 보이도록 설정할 것이다.

 

위의 명령어에 대해 하나씩 살펴보자 (명령어 해석)

 

1️⃣ $ git config

git의 설정을 변경하는 명령어

 

2️⃣ $ [optional]

이 부분에는 --global , --local , --system 의 명령어가 들어갈 수 있다.

 

[1] --global 인 경우

$ git config --global commit.template [path of template]

해당 git 설정을 전역으로 변경하겠다.

즉, 해당 사용자의 모든 GIT 프로젝트에 적용된다.

 

[2] --local 인 경우

$ git config --local commit.template [path of template]

해당 git 설정을 지역으로 변경하겠다.

즉, 해당 사용자가 현재 작업 중인 GIT 프로젝트만 적용된다.

프로젝트 내에서만 설정이 유효하고, 외부 프로젝트에서는 해당 git 설정을 사용할 수 없다.

 

[3] --system 인 경우  (사용하길 권장하지 않음! 만약 꼭 사용한다면 조심해서 사용해야 한다!)

$ git config --system commit.template [path of template]

해당 git 설정이 시스템 전체에 적용된다.

즉, 모든 사용자 및 모든 GIT 프로젝트에 적용된다.

(*일반적으로 시스템 전체 설정을 변경하기 위해서는 관리자 권한(sudo)이 필요하다.)

시스템 레벨 설정을 변경하는 것은 주의해야 하고, 꼭 필요한 경우에만 사용해야 한다.

개인 프로젝트나 팀 프로젝트할 때는 전역/지역 설정을 사용하는 것이 일반적이다.

 

4️⃣ $ commit.template [path of template]

해당 경로 위치에 있는 템플릿 파일을 커밋 메시지 템플릿으로 지정하는 명령어

 

 

 

따라서 위의 명령어를 본인 프로젝트에 맞게 작성하면 된다.🧚

 

 

여기까지 작업이 완료되었다면 $ git add 명령어 로 staging area에 이동시킨 뒤

원격저장소에 저장하기 위해 $ git commit 명령어로 메시지 템플릿이 에디터에서 열리는지 확인해보자😊

 

 

 

---

[실습]

나는 위와 같이 프로젝트 내부에 .gitmessage를 생성해주었고, 해당 프로젝트에서만 적용하고 싶기 때문에

.gitmessage가 있는 위치에서 아래 명령어를 입력하였다.

$ git config --local commit.template .gitmessage

아무것도 나오지 않으면 잘 설정된 것이다.

 

 

git add 이후, git commit 명령어 입력하면 아래와 같이

'hint: Waiting for your editor to close the file... '이라는 힌트가 나오면서

COMMIT_EDITMSG 가 나오게 된다.

위와 같이 나온 템플릿을 수정하여 (#가 있으면 주석으로 인식되어 저장이 안 됨)

git commit message를 작성하면 된다!!!!

 

 

실습 끝!🙌

 

 

 

---

[참고]

• Git Convension
  • https://udacity.github.io/git-styleguide 
  • https://velog.io/@archivvonjang/Git-Commit-Message-Convention
• Gitmoji 사용
  • https://github.com/carloscuesta/gitmoji 
  • https://treasurebear.tistory.com/70
• Git commit message template
  • https://git-scm.com/book/ko/v2/Git%EB%A7%9E%EC%B6%A4-Git-%EC%84%A4%EC%A0%95%ED%95%98%EA%B8%B0

https://velog.io/@ye-ji/Git-PR-%EC%9E%98-%EC%93%B0%EB%8A%94-%EB%B0%A9%EB%B2%95