Git Hooks란?
Git hooks는 commit, push, receive와 같은 특정 이벤트 전후에 Git이 자동으로 실행하는 스크립트입니다. Git의 기본 제공 기능으로, 동작을 사용자 정의하고 워크플로에서 작업을 자동화할 수 있습니다.
Hooks는 모든 Git 저장소의 .git/hooks 디렉터리에 저장됩니다. 저장소를 초기화하면 Git은 이 디렉터리를 여러 예제 스크립트로 채웁니다.
문제 상황
프로젝트에 특정 표준을 적용하고 싶습니다. 예를 들어, 다음을 보장하고 싶습니다.
- 모든 코드는 커밋되기 전에 린트(lint) 검사를 받습니다.
- 커밋 메시지는 특정 형식을 따릅니다.
- 코드를 원격 저장소에 푸시하기 전에 테스트가 실행됩니다.
이러한 작업을 수동으로 기억하는 것은 오류가 발생하기 쉽습니다. Git hooks가 이를 자동화할 수 있습니다.
해결 방법
1. Hooks 디렉터리 찾기
Git 저장소 내의 hooks 디렉터리로 이동합니다.
cd .git/hooks
ls
다음과 같은 샘플 hook 파일 목록이 표시됩니다.
pre-commit.sampleprepare-commit-msg.samplecommit-msg.samplepost-commit.samplepre-push.sample
2. Hook 생성하기
hook을 활성화하려면 .git/hooks 디렉터리에 올바른 이름과 확장자가 없는 파일을 만들어야 합니다. 예를 들어, pre-commit hook을 만들려면 pre-commit이라는 파일을 만듭니다.
린터를 실행하는 간단한 pre-commit hook을 만들어 보겠습니다.
- 샘플 파일의 이름을 바꾸거나 복사합니다.
cp pre-commit.sample pre-commit - 스크립트를 실행 가능하게 만듭니다.
chmod +x pre-commit - 편집기에서
pre-commit파일을 열고 스크립트를 추가합니다. 셸 스크립트이거나 Python 또는 Ruby와 같은 다른 스크립팅 언어를 사용할 수 있습니다.
다음은 스테이징된 파일에 대해 린터를 실행하는 간단한 셸 스크립트 예제입니다.
#!/bin/sh
echo "Running linter before commit..."
# 린터 명령을 실행합니다. 예를 들어, JavaScript 프로젝트의 경우:
npm run lint
# 린터가 실패하면 0이 아닌 상태로 종료되어
# 커밋이 중단됩니다.
if [ $? -ne 0 ]; then
echo "Linting failed. Aborting commit."
exit 1
fi
echo "Linting passed."
exit 0
이제 git commit을 실행할 때마다 이 스크립트가 실행됩니다. npm run lint 명령이 실패하면 커밋이 중단됩니다.
일반적인 Hooks
pre-commit: 커밋 메시지를 입력하기 전에 실행됩니다. 커밋하려는 스냅샷을 검사하는 데 사용합니다. 여기서 테스트나 린팅을 실행할 수 있습니다.commit-msg: 커밋 메시지를 인수로 받습니다. 필요한 패턴에 대해 메시지를 유효성 검사하거나 정보를 자동으로 추가하는 데 사용합니다.pre-push: 코드를 원격 저장소에 푸시하기 전에 실행됩니다. 손상된 코드를 푸시하지 않도록 테스트를 실행하는 데 사용합니다.
Hooks 공유하기
Git hooks는 프로젝트의 나머지 부분과 함께 복제되지 않습니다. 각 개발자의 저장소에 로컬입니다. 이는 악성 스크립트가 자동으로 실행되는 것을 방지하기 위한 보안 조치입니다.
팀과 hooks를 공유하려면 다음을 수행할 수 있습니다.
- 프로젝트 내의 디렉터리(예:
scripts/hooks)에 hooks를 저장합니다. - 이를
.git/hooks디렉터리로 복사하거나 심볼릭 링크하는 스크립트를 만듭니다. - 개발자가 저장소를 복제한 후 이 설정 스크립트를 실행하도록 합니다.
JavaScript 프로젝트용 Husky와 같은 일부 도구는 Git hooks를 더 쉽게 관리하고 공유하는 데 도움이 될 수 있습니다.
결론
Git hooks는 개발 워크플로에서 작업을 자동화하고 표준을 적용하는 강력한 메커니즘입니다. pre-commit 및 pre-push와 같은 hooks를 사용하여 문제를 조기에 발견하고 프로젝트에서 높은 수준의 코드 품질을 유지할 수 있습니다.
전문 보완 체크
Git Hooks를 사용하여 작업 자동화하기에서 중요한 기준은 독자가 한 번 따라 해서 성공했는지가 아닙니다. 이 주제는 재현 가능한 디버깅 절차로 다루는 편이 안전합니다. 결론을 내리기 전에 저장소 루트, 브랜치와 원격 상태, 인덱스와 작업 트리, 인증 또는 네트워크 경계를 확인해야 합니다. 또한 나중에 같은 문제가 반복될 수 있으므로, 관찰한 사실과 사용한 가정, 결론이 바뀔 조건을 짧은 결정 기록으로 남기는 것이 좋습니다.
신뢰도를 높이는 증거
작업을 바꾸기 전에는 객관적인 증거를 먼저 확인해야 합니다. 쓸 만한 증거에는 git status, git remote -v, git branch --show-current, 실패한 정확한 명령가 포함됩니다. 증거가 서로 맞지 않으면 억지로 하나의 이야기로 합치지 말고 충돌 자체를 남겨야 합니다. 빠른 해결이 한 번 성공했더라도 같은 입력, 계정, 의존성, 기기 상태에서 다시 확인하지 않았다면 아직 확정된 해결책이라고 보기 어렵습니다.
검토 표
| 검토 항목 | 확인할 내용 | 중요한 이유 |
|---|---|---|
| 범위 | 이 글이 다루는 정확한 사례 | 조언을 과도하게 적용하지 않게 합니다 |
| 기준 상태 | 변경 전 상태 | 되돌리기와 비교를 가능하게 합니다 |
| 변경 | 실제로 수행한 가장 작은 조치 | 숨은 부작용을 줄입니다 |
| 결과 | 변경 뒤 관찰한 출력 또는 반응 | 기대와 증거를 구분합니다 |
| 재확인 | 결론을 다시 볼 시점 | 글의 정확도를 유지합니다 |
예외 상황과 실패 모드
주요 위험은 증상만 고치고 원인을 남기는 상황, 서로 무관한 변경을 같은 테스트에 섞는 상황입니다. 생산 데이터, 개인정보, 돈, 건강, 법적 권리, 보안 복구가 관련되어 있다면 넓은 해결책을 바로 적용하기보다 먼저 증거를 모으는 보수적인 접근이 낫습니다. 같은 제목의 문제라도 환경이 다르면 원인이 달라질 수 있으므로, 독자는 명령이나 결정을 복사하기 전에 자신의 조건이 글의 가정과 맞는지 비교해야 합니다.
유지보수 기준
이 안내는 의존성, 운영체제, 빌드 도구가 바뀐 뒤 다시 확인해야 합니다. 좋은 업데이트는 글 전체를 다시 쓰는 것이 아니라 예시, 링크, 명령, 화면, 판단 기준이 현재 동작과 여전히 맞는지 확인하는 일입니다. 기존 결론이 유효하면 확인 날짜를 남기고, 바뀌었다면 무엇이 바뀌었고 왜 이전 조언만으로 부족한지 설명해야 합니다.
실행 전 질문
- 문제나 판단이 실제임을 보여 주는 가장 작은 관찰 신호는 무엇인가?
- 공식 출처는 무엇이고, 내부 판단은 어느 부분인가?
- 변경 전에 반드시 캡처해야 할 기록은 무엇인가?
- 어떤 결과가 나오면 이 글의 조언이 맞지 않는다고 볼 것인가?
- 같은 문제가 반복될 때 누가 이 기록을 다시 봐야 하는가?
함께 보면 좋은 글
같은 주제 흐름에서 이어서 읽기 좋은 글입니다.
Leave a comment