[Github Hook] Jira 티켓 번호 커밋 메시지 자동 추가하기

이번 프로젝트에서 처음으로 Jira를 쓰면서 커밋 메시지에 매번 이슈를 추가해야 했다.

 

그래서 hook을 이용해서 자동으로 커밋 메시지 앞에 지라 이슈 번호가 붙도록 설정했다!

 

내 설정

1. BRANCH NAMING : feature/[SO-이슈번호]-브랜치 상세 설명
ex) feature/SO-26-settings
2. feature 브랜치에서만 작업할 때 이 메시지가 붙도록 설정
main master develop release hotfix인 경우 pass

 

처음에는...

아래 링크를 참고해서 하려고 했으나? 이상하게도 돌아가지 않았다

 

https://medium.com/prnd/github-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%84%B8%EC%A7%80%EC%97%90-jira-%EC%9D%B4%EC%8A%88%EB%B2%88%ED%98%B8-%EC%9E%90%EB%8F%99%EC%9C%BC%EB%A1%9C-%EB%84%A3%EC%96%B4%EC%A3%BC%EA%B8%B0-779048784037

GitHub 커밋 메세지에 JIRA 이슈번호 자동으로 넣어주기

https://overcome-the-limits.tistory.com/680?category=923736 

[협업] 협업을 위한 JIRA 이슈 번호 커밋 메시지 자동 추가하기

 

다른 것도 찾아보았으나?

여기에는 (2)인 브랜치 필터링 규칙이 없어서 아쉬웠다. 하지만 돌아는 감

https://blog.deering.co/commit-convention/

git branch 이름과 hook으로 commit message 컨벤션 강제하기

 

결국..

둘을 합치기로 했다. 난 진짜 정규식 잘 모르는데 어찌저찌 참고해서 썼음

cd {프로젝트 경로}/.git/hooks
vi prepare-commit-msg.sample 
mv prepare-commit-msg.sample prepare-commit-msg # 이름 변경하기

 

prepare-commit-msg 코드

#!/bin/sh  
# .git/hooks/prepare-commit-msg  
#  
# Automatically add branch name and branch description to every commit message except merge commit.  
# https://stackoverflow.com/a/18739064  
#  
  
COMMIT_MESSAGE_FILE_PATH=$1  
  
# feature 브랜치에서만 되도록 함
if [ -z "$BRANCHES_TO_SKIP" ]; then
  BRANCHES_TO_SKIP=(main master develop release hotfix)
fi

BRANCH_NAME=$(git symbolic-ref --short HEAD)
BRANCH_NAME="${BRANCH_NAME##*/}"
BRANCH_EXCLUDED=$(printf "%s\n" "${BRANCHES_TO_SKIP[@]}" | grep -c "^$BRANCH_NAME$")

# merge commit에 대해서는 prefix를 생성하지 않는다.  
MERGE=$(grep -c -i 'merge' < "$COMMIT_MESSAGE_FILE_PATH")  
if [ "$MERGE" != "0" ] ; then  
  exit 0  
fi  

if [ $BRANCH_EXCLUDED != 1 ]; then
  PREFIX=$(git branch | grep '\*' | sed 's/* //' | sed 's/^.*\///' | sed 's/^\([^-]*-[^-]*\).*/\1/')
  echo "[$PREFIX] $(cat "$COMMIT_MESSAGE_FILE_PATH")" > "$COMMIT_MESSAGE_FILE_PATH"
fi

 

 

사용후기

잘 돌아가서 아주 편하다! 이제 hook의 존재를 알았으니 본격적으로 개발이 시작되기 전에 pre-commit도 작성해놓고 싶다

 

https://coderecording.tistory.com/4

[Git] hook을 활용한 통일성 있는 commit message