Git

[Git] Pull Request와 이슈 연결하기 [5/14 study]

동혁이 2024. 5. 14. 22:56

 

 

Pull Request와 이슈 연결하기

 

 

 

 

❗️공식사이트 참조

https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

 

Linking a pull request to an issue - GitHub Docs

You can link a pull request or branch to an issue to show that a fix is in progress and to automatically close the issue when the pull request or branch is merged.

docs.github.com

https://minny27.tistory.com/50

 

[Git] Issue 생성 및 Pull Request 와 연동

오늘의 결과 화면입니다. 구현할 기능을 Issue로 생성하고 Pull Request를 만들어서 Issue를 참조하고 main branch에 sub branch를 merge 후, 병합된 Issue를 closed 하는 과정을 설명하겠습니다. [Step 1] 새로운 Issu

minny27.tistory.com

 

 

❗️Pull Request를 이슈에 연결하여 수정이 진행중임을 표시하고 Pull Request가 병합될 때 자동으로 이슈를 닫을 수 있습니다.

 

❗️연결된 이슈와 Pull Request

키워드를 사용하거나 수동으로 Pull Request를 이슈에 연결할 수 있습니다.

Pull Request를 이슈와 연결하면 같이 작업하는 사람은 누군가가 문제를 해결하고 있음을 알 수 있습니다.

연결된 Pull Request를 저장소의 기본 브랜치에 병합하면 연결된 이슈가 자동으로 닫힙니다.

 

❗️Pull Request를 수동으로 이슈에 연결하기

저장에 쓰기 권한이 있는 사람은 Pull Request를 이슈에 수동으로 연결할 수 있습니다. 

각 Pull Request에 최대 10개의 이슈를 수동으로 연결할 수 있습니다. 이슈 및 Pull Request를 동일한 저장소에 있어야 합니다.

 

  • Github 에서 저장의 메인페이지로 이동하세요. 
  • 저장 이름 아래에 Pull Requests 를 클릭하세요.

 

  • Pull Request 목록에서 이슈에 연결할 Pull Request를 클릭하세요. 
  • 오른쪽 사이드바에 연결된 Linked Issues 를 클릭하세요.

  • Pull Request에 연결할 이슈를 선택하세요.

 

 

❗️키워드를 사용해 Pull Request를 이슈에 연결하기

 

Pull Request Description에서 지원하는 키워드를 사용하여 Pull Request를 이슈에 연결할 수 있습니다.

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

닫는 키워드는 이슈가 Pull Request와 동일한 저장소에 있는지에 따라 다릅니다.

 

Linked issue Syntax Example
이슈가 같은 저장소에 있을 때 KEYWORD #ISSUE-NUMBER Closes #10
이슈가 다른 저장소에 있을 때 KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER Fixes octo-org/octo-repo#100
이슈가 여러개일 때 Use full syntax for each issue Resolves #10, resolves #123, 
resolves octo-org/octo-repo#100

 

수동으로 연결된 Pull Request만 수동으로 연결을 해제할 수 있습니다. 키워드를 사용해 연결한 이슈를 연결 해제 하기 위해선 Pull

Request Description을 수정해서 키워드를 제거해야 합니다.

 

커밋 메시지에서 닫기 키워드를 사용할 수 있습니다. 커밋을 기본 브랜치로 병합하면 이슈는 종료되지만 커밋이 포함된 Pull Request는 연결된 Pull Request로 표시되지 않습니다.

 

 

🔥마무리

팀 프로젝트 협업할때 필수인 깃&깃허브 공부를 하기 시작하면서 Issue를 올리고 PR을 올렸는데 처음에는 PR 하나 씩 머지하고 Issue도 전부 수동으로 직접 닫아줬었는데 자동으로 닫힐 수 있게 하는 방법이 있었다니 너무 편합니다!!

오늘도 모두 화이팅!!! ㅎㅎ