[#1] Jira 협업툴 github과 연동 | Husky로 commit message Jira 티켓번호 자동화

1. Jira 설치 및 github 연동 

구글링해서 보면 자료가 엄청 많고 쉽다.

2.  Husky로 commit message Jira 티켓번호 자동화

여기서부터가 시간이 좀 걸렸다. 

 

처음에는 직접 .git/hooks에 prepare-commit-msg를 생성해서 하는 방법을 사용했다. 하지만 더 간편한 방법이 있었다. 바로 husky를 사용하는 것이다. 설정 과정도 매우 간단하다. 

 

터미널 내 위치: ../프로젝트명 (내경우 프로젝트이름이 co-task) -> ../co-task

 

1) husky 설치

npm install husky jira-prepare-commit-msg --save-dev && npx husky install

(이때 husky/_ 경로는 잘못된게 아니고 사용하는 훅은 /husky경로에서 만들어진다)

 

2) 훅 생성

 add 명령어를 사용해서 만들면 "add command is deprecated"메세지가 뜬다. 버전이 바뀐 것 같다. 그래서 husky 공식문서를 확인해보니 아래와 같이 명령어를 사용하면 파일이 생성된다.

echo .husky/prepare-commit-msg

 

3) 훅 파일 편집

nano .husky/prepare-commit-msg // nano: 파일 편집 명령어

#!/usr/bin/env sh. 
"$(dirname -- "$0")/_/husky.sh" 

npx jira-prepare-commit-msg $1

파일 저장 후, 빠져나오기: ctrl + x -> Y -> enter

 

4) 해당 프로젝트의 package.json 수정

  // 최상단 
  "jira-prepare-commit-msg": {
    "messagePattern": "[$J] $M",
    "jiraTicketPattern": "([A-Z]+-\\\\d+)",
    "commentChar": "#",
    "isConventionalCommit": false,
    "allowEmptyCommitMessage": false,
    "gitRoot": ""
   }

 

5) clone 받아서 사용하는 팀원들이 npm intall 했을 때 자동으로 husky도 설치

 "scripts": {
 "postinstall": "husky install",
 ...
}

 

여기까지 했으면 테스트만 남았다. 

 

3. Jira 이슈 발행 후, commit message 테스트

1) 아래에서 보면, 하위 이슈를 생성했고 티켓 넘버는 QIHI-9임을 확인할 수 있다. 

 

2) 오른쪽 하단 스티커 부분을 보면 개발 > 브랜치 만들기 > 코드 복사 (사진은 이미 만든 상태)

 

3) 터미널로 온다. 복사한 코드로 브런치를 따고 commit을 한다. 

전체적인 흐름은 위와 같다. 여기서 필요한 코드는 git commit 하는 일반적인 방법이다.

git checkout -b QIHI-9-jira-티켓넘버-commit-msg-테스트 // 복사한 코드
 
git add -A // 수정한 사안 저장하고

git commit -m "test" // commit 메세지 작성

git push --set-upstream origin QIHI-9-jira-티켓넘버-commit-msg-테스트 // git push 입력시 해당 코드 추천-> 복붙

 

4) 깃헙가서 확인

 

해당 브런치 이름으로 commit 메세지가 잘 생성된 것을 볼 수 있다. 

 

위 방법이 Jira -> github 플로우라면 반대로 github -> Jira도 있다. 두 개를 다 알아본 이유는 다음 페이지에...