Skip to content

Commit

Permalink
githooks 설정하기 글 수정
Browse files Browse the repository at this point in the history
 - 가독성 개선
 - 따라했을 때 안되는 내용 수정
  • Loading branch information
kdkdhoho committed Jan 23, 2024
1 parent e48bb83 commit 02eb779
Showing 1 changed file with 10 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ tags: ["git", "github"]
- MacOS 14.2.1(23C71)
- IntelliJ 2023.2.5 (Ultimate Edition)

## 컨벤션 정하기
## 1. 컨벤션 정하기

해당 작업을 수행하기 전 _브랜치 네이밍 컨벤션__커밋 메시지 컨벤션_ 을 먼저 정해야 합니다.

이번 글에선 브랜치 네이밍 컨벤션을 `type/issue_number` 와 같은 형식으로, 커밋 메시지 컨벤션을 `type: message (#1)`와 같이 설정하겠습니다.<br>
> 예) 브랜치 네이밍 컨벤션 : `feat/1`<br>
> 커밋 메시지 컨벤션 : `feat: 기능 구현 (#1)`
## 스크립트 작성
## 2. 스크립트 작성

프로젝트의 루트 위치 아래에 `.githooks` 디렉터리를 만들고 그 안에 `commit-msg`를 만들어주세요.<br>
`commit-msg`는 단순히 file 형태로 만들면 됩니다.
Expand Down Expand Up @@ -80,15 +80,13 @@ fi
printf "%s %s %s" "$PREFIX" "$MESSAGE" "$POSTFIX" > "$COMMIT_MESSAGE_FILE_PATH"
```
## git hooks 설정
## 3. git hooks 설정 (Makefile 이용)
git hooks를 설정해야 작성한 `/.githooks/commit-msg` 스크립트를 적용할 수 있습니다.
git hooks를 설정해야 작성한 스크립트를 **적용** 수 있습니다.
레포지토리에서 clone한 프로젝트를 로컬 환경에서 설정하기 위해
설정하기 위한 명령어는 `git config core.hooksPath .githooks` 입니다.
`git config core.hooksPath .githooks` 명령어를 입력해야 합니다.
이 외에도 권한 부여 명령어를 한꺼번에 편하게 작성하게 위해 Mac(or Linux) OS에 기본적으로 제공되는 [Makefile](https://www.gnu.org/software/make/)를 이용하겠습니다.
하지만 git hooks 설정 외에도 권한 관련 설정을 한번에 편하게 하기 위해 Mac(or Linux) OS에 기본적으로 제공되는 [Makefile](https://www.gnu.org/software/make/)를 이용하겠습니다.
---
Expand All @@ -102,21 +100,22 @@ Makefile에 아래의 코드를 작성합니다.
init:
git config core.hooksPath .githooks
chmod +x .githooks/commit-msg
git update-index --chmod=+x .githooks/commit-msg
git update-index --add --chmod=+x .githooks/commit-msg
```
> - Makefile 문법 상, 띄어쓰기가 아닌 Tab을 입력해야 합니다.<br>
> <br>
> 코드 설명
> - `git config core.hooksPath .githooks`: git hooks의 위치를 .githooks로 변경합니다.<br>
> - `chmod +x .githooks/commit-msg`: ./githooks/commit-msg 파일을 실행할 권한을 부여합니다.<br>
> - `git update-index --chmod=+x .githooks/commit-msg`: git이 .githooks/commit-msg 파일을 실행할 권한을 부여합니다.
> - `git update-index --add --chmod=+x .githooks/commit-msg`: git이 .githooks/commit-msg 파일을 실행할 권한을 부여합니다.
>
그 다음 터미널에서 `make` 명령어를 입력해 위 파일을 실행시켜줍니다.
![결과](result_after_make.png)
## 확인하기
## 4. 확인하기
이제 끝났습니다.
Expand Down

0 comments on commit 02eb779

Please sign in to comment.