Github Issue 똑똑하게 사용하기
Github Issue는 Github에서 제공하는 편리한 기능이다. 레포지토리마다 Issue를 생성해서 관련된 문제사항이나 앞으로 작성해야 하는 작업 사항들을 적어 보관해 둘 수 있다. 대부분의 경우 버그리포트를 작성하거나 진행중/계획하고 있는 피처 개발 계획 등을 적어두는 방식으로 하는데, Github에서 제공하는 여러가지 부가기능들을 통해 정말 다양한 방식으로 활용할 수 있는 기능이다.
숨겨진 꿀기능 중 하나로 Issue에서 직접 Branch를 생성할 수 있는 기능이 있다! 이렇게 Branch를 생성하면 Issue와 Branch가 연결관계를 가지게 되서, Branch가 main에 머지되면 자동으로 Issue가 닫히는 등 소소한 편의기능을 누릴 수 있다(Branch 이름짓는 수고가 덜 든다는 더 소소한 장점도 있다). Branch 생성 기능은 아래와 같은 순서로 사용할 수 있다.
1. Issue에 들어가서 좌측에 있는 create a branch 버튼을 누른다.
2. Branch를 생성할 Source 브랜치를 고르고, 브랜치명을 확인/수정한다.
3. Create Branch 버튼을 누르면 Branch 생성 완료!
Github는 Commit을 Branch와 연결짓는 기능도 제공한다. 아주 간단하게 Commit message에 #<Issue Number> 구문이 포함되면 remote에 올라 갈 때 자동으로 Issue에 해당 커밋을 참조하고 있다고 표시가 생겨난다.
이에 더해서 만약 Commit에 아래와 같은 키워드가 있는 경우 Issue를 자동으로 닫아줄 수도 있다!
close
closes
closed
fix
fixes
fixed
resolve
resolves
resolved
다만, Issue 닫기 기능은 해당 커밋이 main branch에 merge되었을 때만 동작한다. 또, 동시에 여러개의 Issue를 커밋 메시지에 언급하는 경우, 맨 앞의 하나만 연결되는 단점이 있다.