[Git] PR / Commit 메시지 키워드로 이슈 연동 및 종료하기

키워드 기능 소개

---

💡 Special Keyword 기능 작동 조건

• PR 타겟이 레포지토리의 default branch 일 때
• PR의 base가 default branch 일 때

 

PR Description 혹은 Commit 메시지(Subject 혹은 Description)에 키워드 #이슈번호를 추가하면 입력한 이슈가 자동으로 링크되며, 해당 Commit 혹은 PR을 기본 브랜치(default branch)에 Merge 했을 때 링크한 이슈도 자동으로 닫힌다.

git commit -m "Feat: order filter close #15"

 

Fork GUI를 사용한다면 커밋 메시지 Description에 부분에 Special Keyword를 입력할 수도 있다

참고로 브랜치 이름에 이슈 번호를 기재하면(#889-feat-…) 자동으로 입력한 이슈를 참조한다. 커밋을 추가하면 해당 이슈에 아래 같은 레퍼런스 히스토리가 남는다.

userA added a commit to repo userA/repo-name that referenced this

 

만약 A라는 PR(풀리퀘스트) 설명에 B 라는 다른 PR을 참조하기 위해 특정 키워드를 사용하면, B PR이 A PR과 링크된다. 이후 A PR을 병합(Merge)하면 참조된 B PR도 자동으로 닫힌다.

If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request also closes the referenced pull request.
다른 풀 리퀘스트의 코멘트를 참조하는 키워드를 사용하면 풀 리퀘스트들이 연결됩니다.
참조하는 풀 리퀘스트를 병합하면 참조된 풀 리퀘스트도 닫힙니다.

 

아래 이미지는 PR Description에 키워드 #이슈번호를 남긴 후 이슈가 자동으로 링크된 화면. 기본 브랜치에 Merge하면 해당 이슈가 자동으로 닫힌다. Commit 메시지를 통해 링크된 이슈는 Development 부분엔 표시되지 않지만 역시 Merge하면 자동으로 닫힌다.

 

 

지원하는 키워드

---

💡 키워드를 사용해 자동으로 링크된 이슈를 해제하려면(링크 해제) PR 설명을 직접 편집해야되는 점 참고

 

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

 

키워드 Syntax

---

💡 동일 레포지토리 여부에 따라 키워드 Syntax가 다르므로 주의

 

Linked issue	Syntax	Example
Issue in the same repository	KEYWORD #ISSUE-NUMBER	Closes #10
Issue in a different repository	KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER	Fixes octo-org/octo-repo#100
Multiple issues	Use full syntax for each issue	Resolves #10, resolves #123, resolves octo-org/octo-repo#100

 

레퍼런스

---

Linking a pull request to an issue - GitHub Docs

 

---

글 수정사항은 노션 페이지에 가장 빠르게 반영됩니다. 링크를 참고해 주세요