git commit전 git hook 거는방법

개요

git hook을 통하여 개발편의성을 올려보고자 합니다.

 

 

Git Hook

Git은 특정 상황에 특정 스크립트를 실행할 수 있도록 Hook이라는 기능을 지원합니다.

 

Git Hook 목록 찾아보기

cd ./git/hooks/
ls

현재 가지고 있는 git repository에 접근합니다.

./git/hooks/ 디렉터리로 이동하여 가지고 있는 파일을 조회해 보면 여러개의 .sample 확장자 파일이 존재합니다.

 

.sample 확장자 파일들

 

pre-commit, pre-push 등의 이름으로 어떤일을 하는지 예측해 볼 수 있습니다. (커밋 전, 푸시하기 전)

정확한 설명은 git의 문서에서 확인해 볼 수 있습니다.

https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

Git - Git Hooks

 

 

pre-push 활용해 보기

Windows에서는 .git 폴더가 숨김 처리 되어있습니다. (탐색기 메뉴 [보기 - 표시/숨기기 - 숨김 항목 체크]))

intellij ultimate를 사용하시고 계신다면 idea .\pre-push.sample 명령어로 해당 파일을 수정할 수 있습니다.

pre-push를 활용하기 위해서는 파일이름이 pre-push.sample 에서 pre-push로 변경되어야 합니다.

 

windows

notepad .\pre-push.sample

notepad 명령어를 활용하여 메모장을 열었습니다.

 

#!/bin/sh

./gradlew check

모든 내용을 지우고 gradlew check를 입력합니다.

.gradlew check는 lint확인 및 테스트를 수행합니다.

 

이제 실패하는 테스트가 존재하면 push에 자동으로 실패합니다.

 

어떤 경우에 활용하면 좋을까?

Lint 검사를 통해 코드 포맷팅을 검사하거나, Test를 수행하는 등을 자동화하여 개발자의 편의성과 시간을 아낄 수 있게 됩니다.

 

 

참고자료

https://www.baeldung.com/gradle-test-vs-check