Git Hook을 이용해 자동으로 커밋메세지에 JIRA 이슈키 넣어주기

tags

Git

summary

type

Post

맥북 숨김폴더 확인 : shift + command + .

vscode 숨김폴더 설정

# Visual Studio Code 에디터에서 .git 등 숨김 파일/폴더 표시 방법 VS-Code 에서 .git 등의 숨김 폴더/파일을 표시하는 방법을 정리한다. 1. 설정 화면 진입 - Settings 항목을 클릭한다. 2. "exclude" 검색 - Files:Exclude 항목에 **/.git 등 숨김 폴더/파일들이 설정되어 있다. 3. 표시하고 싶은 숨김항목을 Files: Exclude 에서 제거 - 마우스를 올리면 나타나는 X버튼을 클릭하여 숨김항목을 제거한다. * 연필 모양 아이콘을 클릭하며 편집 가능하다. * Add Pattern 버튼을 클릭하여 추가도 가능하다.

https://curryyou.tistory.com/496

프로젝트 루트 경로((레포 클론 뜨면 있는 폴더)에 있는 숨김 폴더로 되어있는 .git 폴더 열기

.git/hooks/prepare-commit-msg.sample 파일 열기

아래 코드가 초기에 작성되어 있지만 4번에 있는 코드로 수정해야 해요 (그냥 미리 작성되어 있는 게 있다는 거 알려주려고 넣은 것)

#!/bin/sh
#
# An example hook script to prepare the commit log message.
# Called by "git commit" with the name of the file that has the
# commit message, followed by the description of the commit
# message's source.  The hook's purpose is to edit the commit
# message file.  If the hook fails with a non-zero status,
# the commit is aborted.
#
# To enable this hook, rename this file to "prepare-commit-msg".

# This hook includes three examples. The first one removes the
# "# Please enter the commit message..." help message.
#
# The second includes the output of "git diff --name-status -r"
# into the message, just before the "git status" output.  It is
# commented because it doesn't cope with --amend or with squashed
# commits.
#
# The third example adds a Signed-off-by line to the message, that can
# still be edited.  This is rarely a good idea.

COMMIT_MSG_FILE=$1
COMMIT_SOURCE=$2
SHA1=$3

/usr/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE"

# case "$COMMIT_SOURCE,$SHA1" in
#  ,|template,)
#    /usr/bin/perl -i.bak -pe '
#       print "\n" . `git diff --cached --name-status -r`
# 	 if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;;
#  *) ;;
# esac

# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE"
# if test -z "$COMMIT_SOURCE"
# then
#   /usr/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE"
# fi

아래 코드로 수정하기 (어차피 이전 코드는 .sample 확장자가 있었던 거라 작동 안 하던 코드니까 싹 다 갈아 엎으시면 됩니다.)

#!/bin/bash

BRANCH_NAME=$(git symbolic-ref --short HEAD)
JIRA_ID=$(echo "$BRANCH_NAME" | egrep -o 'LAS-[0-9]+')

if [ -n "$JIRA_ID" ]; then
  COMMIT_MSG_FILE="$1"
  COMMIT_MSG_HEAD=$(head -n 1 "$COMMIT_MSG_FILE")

  if [[ "$COMMIT_MSG_HEAD" != "[$JIRA_ID]"* ]]; then
    sed -i.bak -e "1s/^/[$JIRA_ID] /" "$COMMIT_MSG_FILE"
  fi
fi