Git - 커밋 메시지에 #이슈번호 추가

Github Repository에서 제공하는 기능

Github에 저장소(Repository)를 생성하면 다음과 같이 코드 형상관리 뿐만 아니라 이슈, PR(풀 리퀘스트), 프로젝트, 마일스톤, 위키 등의 관리가 가능하다.

Github 저장소 메뉴

 

 

각 메뉴는 다음과 같은 특징을 갖는다.

 

Issues

- 프로젝트 작업의 모든 활동을 아우르는 단위(기능 추가, 환경 설정, 리팩토링, 버그 수정 등)

- 모든 작업을 이슈로 만들고, 등록한 이슈를 기반으로 프로젝트 관리

- 마일스톤 생성 및 관리 가능

 

PR(Pull Requests)

- 작업 브랜치의 내용을 메인 브랜치에 병합하기 전에 다른 참여자들과 공유하고 리뷰를 요청할 수 있는 메뉴

- 코드 리뷰를 통한 수정 코드 추천, 강제 어프루브 제약 사항 추가 등 다양한 기능 제공

 

Projects

- 이슈 관리를 위한 

- 칸반 보드처럼 각 할일과 이슈들을 관리할 수도 있음

 

Wiki

- 프로젝트에 대한 문서를 정리할 수 있는 메뉴

- github 마크다운 문법 사용 가능

 

 

경우에 따라 Issues, Projects, Wiki 메뉴가 보이지 않는 경우가 있다.

 

만약 화면에 없는 메뉴가 있는 경우에는 settings - Features에 들어가서 체크 후 저장하면 메뉴가 정상적으로 표출된다.

settings - Features 메뉴

 

 

생성한 이슈 관리

생성한 이슈를 관리하는 방법에 대해 알아보자.

 

커밋을 할 때, 커밋 메시지에 #[이슈번호] 형태로 이슈 번호를 추가하면 자동으로 해당 커밋을 인식하여 이슈에 연결을 해주기 때문에 연관 작업에 대한 관리가 쉬워진다.

git commit -m "#10 #17 포탈 컴포넌트 추가"

 

이슈 번호를 추가 후 커밋을 하게 되면 아래와 같이 이슈 상세 페이지에서 연결된 커밋을 확인할 수 있다.

이슈 번호가 붙은 커밋을 자동으로 인식

 

하지만 -m 옵션을 사용하지 않고 여러 줄로 커밋 메시지를 남기는 경우에는 에디터의 주석을 나타내는 기호(#)와 이슈 번호 기호가 충돌되어 주석처럼 동작하게 된다.

 

이럴 때는 커밋 코멘트의 주석 기호를 변경해주면 된다.

git config --global core.commentChar ';'

 

위 코드는 주석 기호를 ;로 변경하는 코드이다. 사용하기 편한 기호로 변경하자.

(참고로 // 기호로 변경 시 에디터에서 오류가 발생한다.)