본문 바로가기

개발바닥/Github

[개발] Github 이슈와 커밋 메시지를 연결해보자

안녕하세요 devport 입니다. Github에 이슈를 대응하고 커밋할 때에 특정 포맷을 사용하게된다면 커밋된 내용이 자동으로 이슈에 반영되는 기능에 대해서 간단히 알아보도록 하겠습니다.

 

Github commit message 이슈에 자동 링크

Github의 Repository에 대하여 Commit Message에 "#[Issue Number]"를 입력하게 될 경우 자동으로 이슈에 커밋 내용을 추가하게 됩니다.

Gihub에 Issue의 내용을 보면 Issue Number를 가지게 됩니다.

추가된 이슈는 커밋 메시지와 함께 링크를 제공하게 되며 링크를 클릭하게 되면 변경 이력에 대하여 출력 하게 됩니다.

 

링크를 클릭하게되면 변경이력을 확인해 볼 수 있습니다.

커밋과 함께 이슈를 Close 할 수 있는 Keyword

이슈에 올라온 버그 또는 기능을 수정하였을때에 Commit Message에 적절한 키워드를 사용하게되면 이슈를 같이 Close 할 수 있어 굳이 이슈에 들어가 Close 상태로 전환하지 않아도 되어 편리합니다.

 

Keyword

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved

요약하자면 ... GIthub Message Format

이슈에 커밋 자동 등록 하기

#2 - 기능에 대해서 수정하였습니다.

이슈에 커밋 자동 등록 및 이슈 닫기

fix #2 - 버그를 수정하였습니다.