Git Hooks

ESLint, Prettier, Testing …

위에 서술한 모든 도구 또는 규칙은 코드를 작성하거나 협업을 하는데 있어 통일성, 가독성, 안정성 등을 높일 수 있는 아주 유용한 규칙들이다.

이러한 규칙들을 가지고 개발을 진행하게 되면 추후에 발생하게 될 유지, 보수의 비용을 줄여줄 수 있다.

하지만 말만 번지르르하게 하고 정작 정의한 규칙들을 지키지 않으면 말짱 도루묵이다. 이러한 문제를 해결할 수 있도록 하는 것이 바로 Git Hooks다.

아무리 지키려고 노력해도 인간이기 때문에 발생할 수 있는 Human Error까지 모두 잡아내기에는 불가능하다. 그래서 Git hooks를 통해 이러한 규칙들을 강제하면서 무조건 지켜지는 규칙을 만드는 것이다.

Git Hooks

Git Hook이란 Git과 관련된 이벤트가 발생했을 때 특정한 스크립트를 실행하는 기능이다. 크게 클라이언트 훅과 서버 훅으로 나뉘는데 클라이언트 훅은 commit, push, merge 등이 발생하기 전에 실행하는 훅이고 서버 훅은 remote repository로 push가 발생했을 때 실행하는 훅이다.

클라이언트 훅 은 커밋 워크플로 훅, 이메일 워크플로 훅, 그리고 기타 훅 으로 분류할 수 있다.

커밋 워크플로 훅 은 git commit 명령으로 커밋을 할 때 실행하는 훅이고 이메일 워크플로 훅 은 git am 명령으로 이메일을 통해 patch 파일을 적용할 때 실행하는 훅이다. 기타 훅 은 rebase, merge, push 와 같은 이벤트를 실행할 때 실행하는 훅을 포함한다.

분류	훅	설명
커밋워크플로 훅	pre-commit	commit 을 실행하기 전에 실행
	prepare-commit-msg	commit 메시지를 생성하고 편집기를 실행하기 전에 실행
	commit-msg	commit 메시지를 완성한 후 commit 을 최종 완료하기 전에 실행
	post-commit	commit 을 완료한 후 실행
이메일워크플로 훅	applypatch-msg	git am 명령 실행 시 가장 먼저 실행
	pre-applypatch	patch 적용 후 실행하며, patch 를 중단시킬 수 있음
	post-applypatch	git am 명령에서 마지막으로 실행하며, patch 를 중단시킬 수 없음
기타 훅	pre-rebase	Rebase 하기 전에 실행
	post-rewrite	git commit –amend, git rebase 와 같이 커밋을 변경하는 명령을 실행한 후 실행
	post-merge	Merge 가 끝나고 나서 실행
	pre-push	git push 명령 실행 시 동작하며 리모트 정보를 업데이트 하고 난 후 리모트로 데이터를 전송하기 전에 실행. push 를 중단시킬 수 있음

pre-commit

보통 pre-commit hook을 많이 사용하는 것 같다. 커밋할 때 가장 먼저 호출되는 hook으로, git으로 커밋을 남길 때 마다 특정 작업을 자동으로 실행하는 것을 목적으로 한다.

black, isort, flake8 등 가독성과 코드 퀄리티를 높여주는 tool을 자동화시켜주는 tool이다.

pre-push도 자주 사용된다.

Husky

만약 모듈 관리를 위해 npm을 사용하고 있다면, husky를 활용해서 git hook관리를 할 수 있다.

huskyhooks를 통한 pre-push 사용 예시

#!/bin/sh

FORBIDDEN_HTTPS_URL="https://github.com/gabia/git-hooks-study.git" # insert your remote url (https)
FORBIDDEN_SSH_URL="git@github.com:gabia/git-hooks-study.git" # insert your remote url (ssh)
FORBIDDEN_REF="refs/heads/master" # insert branch ref

ARR_GIT_PARAMS=($(echo $HUSKY_GIT_PARAMS))
ARR_GIT_STDIN=($(echo $HUSKY_GIT_STDIN))

remote=${ARR_GIT_PARAMS[0]}
url=${ARR_GIT_PARAMS[1]}

local_ref=${ARR_GIT_STDIN[0]}
local_sha=${ARR_GIT_STDIN[1]}
remote_ref=${ARR_GIT_STDIN[2]}
remote_sha=${ARR_GIT_STDIN[3]}

if [ "$url" != "$FORBIDDEN_HTTPS_URL" -a "$url" != "$FORBIDDEN_SSH_URL" ]
then
    exit 0 # Forked Project 에서는 제한하지 않음
fi

if [ "$remote_ref" == "$FORBIDDEN_REF" ]
then
    echo "DO NOT PUSH it master"
    exit 1 # 금지된 ref 로 push 를 실행하면 에러
fi

exit 0
Bash
복사

그리고 .huskyrc 파일에서 pre-push 훅이 위 스크립트를 실행하도록 설정해주면 된다.

{
    "hooks": {
        "pre-commit": "echo 'Hello World!",
        "pre-push": "./huskyhooks/pre-push"
    }
}
Bash
복사

Reference

Git Hooks 정리

Convention, Git Hooks, Husky

https://velog.io/@milkboy2564/Git-Hooks