GitHub 이슈와 브랜치(pr) 자동 연동 설정

오늘은 GitHub Project 의 칸반 보드에 등록된 이슈와 브랜치 자동 연동 설정에 대해서 알아보려고 합니다.

 

이슈로 등록된 것이 모두 작업이 완료가 되고 이 브랜치가 프로젝트에 병합될 때(pr) 자동으로 Done 으로 이동하게 할 수 있습니다.

 

 

 

우선 작업이 완료되어 원격 브랜치에 병합을 해야 한다는 상황을 가정해 보겠습니다.

 

커밋 메시지에 이렇게 이슈 번호를 넣어주게 되면 해당 커밋이 어떤 이슈에 관한 작업인지 쉽게 확인 가능하기 때문에 넣어주었습니다. 

 

그런 다음 레포지토리로 돌아가서 pr 생성 화면으로 이동합니다.

 

 

 

 

Add a description 쪽에 close #이슈번호 를 작성해주고 pr 을 생성하게 되면 

 

.... 내용
close #이슈번호

 

 

 

우선 이런 식으로 커밋된 내용들이 이슈 번호와 함께 나옵니다. 위에서 커밋 메시지를 작성할 때 이 커밋이 어떤 이슈와 관련된 것인지 명시해서 적어주었기 때문에 커밋과 이슈 번호가 같이 나옵니다.

 

 

그리고 Project 의 칸반보드로 돌아오면 자동으로 이슈가 Done 으로 이동합니다.

 

이게 가능한 이유는 GitHub Projects의 Workflows 기능 때문입니다.

이 기능은 칸반보드 오른쪽 상단을 보시면 나옵니다.

 

 

 

여기를 보시면 When an item(issue, pull request) is closed 된다면 

Set value 를 Done 으로 해라 라는 설정이 되어 있습니다.

 

 

아마 이 부분인 것 같은데 pr 이 병합이 될 때, close # 이슈번호 했던 것을 Done 상태로 바꾼다는 의미인 것 같습니다.

 

 

그리고 여기서 상태가 Done 이면 자동으로 issue 를 닫아라 라고 하는 설정이 되어 있는것 같습니다!

 

정리

핵심은 커밋 메시지에 이 커밋이 어떤 이슈와 관련되어 있는지 명시하기 위해 #이슈번호를 적어두면 좋다 

그리고 pr 생성 시 설명란에 close #이슈번호를 적어주면 GitHub Projects 칸반보드에서 이슈번호가 자동으로 Done 으로 이동되면서 close 된다! 입니다.