Git Hooks

Git Hooks

: Git과 관련한 특정 이벤트에 자동으로 실행되는 스크립트를 지원하는 기능

크게 Client-side Hooks, Server-side Hooks로 나뉩니다.

 

클라이언트 훅의 실행 위치는 개발자 로컬 Git이고, 예시 이벤트로 pre-commit, commit-msg, pre-push 등이 있습니다.

서버 훅은 Git 서버 측 저장소에서 실행되고, 예시 이벤트로 pre-receive, update, post-receive 등이 있습니다.

 

이 글에서는 클라이언트 훅에 대해서 자세히 알아보겠습니다.

 

 클라이언트 훅(Client-side Hooks)

훅 이름	실행 시점	대표 사용 예시
pre-commit	커밋 직전	코드 린트, 테스트 실행, 파일 포맷 검사
commit-msg	커밋 메시지 작성 직후	커밋 메시지 포맷 검증
prepare-commit-msg	커밋 메시지 에디터 열기 전	자동 커밋 메시지 작성
post-commit	커밋 완료 후	Slack 알림 전송, log 작성
pre-push	원격 저장소 푸시 직전	테스트 실행, 커밋 수 제한
post-checkout	브랜치 변경 후	특정 파일 자동 복사, 설정 적용
post-merge	머지 완료 후	의존성 설치, 마이그레이션 실행

 

Git Hooks 적용해보기

Git Hooks는 .git/hooks 디렉토리 안에 저장합니다. hook은 실행가능한 스크립트이며, 설정하고자 하는 훅 이름을 확장자 없이 파일명으로 지정하면 Git Hooks를 적용할 수 있습니다. .git/hooks/pre-commit, .git/hooks/post-merge 이러한 방법으로 파일을 생성하면 됩니다.

 

Git Hooks를 공유하기 위한 방법 : husky

Git Hooks는 .git 디렉토리에 저장합니다. 하지만 .git 디렉토리는 버전 관리 대상이 아니므로 레포지토리에 올라가지 않습니다. 기본적인 Git 체계 하에는 Git Hooks를 공유할 수 없다는 의미입니다. 

 

husky는 클라이언트 훅을 설정하고 관리하기 위한 도구로, Git Hooks를 보다 쉽게 적용할 수 있는 Node.js 기반의 패키지입니다. npm, yarn, pnpm 중 하나를 이용해서 설치 및 실행됩니다. 

 

아래의 방식처럼 pnpm으로 관리되는 프로젝트에 적용해봤습니다. 

 

1. pnpm add --save-dev husky

2. pnpm exec husky init

3. 원하는 훅 파일 생성

 

commit-msg 훅은 커밋 메시지를 작성한 후에 실제 커밋이 저장되기 직전에 실행됩니다. 이 훅은 커밋 메시지의 형식을 자동 검증하여 일관된 커밋 메시지를 강제합니다.

 

pre-commit 훅은 커밋 명령어가 실행되기 직전에 실행됩니다. 이 훅은 커밋 전에 코드에 문법 오류나 스타일 오류가 있는지 자동 확인해줍니다. 실패하면 커밋이 중단됩니다.

 

 

참고 자료

https://library.gabia.com/contents/8492/

가비아 라이브러리

https://typicode.github.io/husky/get-started.html

Get started | Husky