Skip to main content

Linking a pull request to an issue

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.

Note: The special keywords in a pull request description are interpreted when the pull request targets the repository's default branch. However, if the PR's base is any other branch, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.

About linked issues and pull requests

You can link an issue to a pull request manually or using a supported keyword in the pull request description.

When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue.

When you merge a linked pull request into the default branch of a repository, its linked issue is automatically closed. For more information about the default branch, see "기본 분기 변경."

Linking a pull request to an issue using a keyword

You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message. The pull request must be on the default branch.

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

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.

The syntax for closing keywords depends on whether the issue is in the same repository as the pull request.

Linked issueSyntaxExample
Issue in the same repositoryKEYWORD #ISSUE-NUMBERCloses #10
Issue in a different repositoryKEYWORD OWNER/REPOSITORY#ISSUE-NUMBERFixes octo-org/octo-repo#100
Multiple issuesUse full syntax for each issueResolves #10, resolves #123, resolves octo-org/octo-repo#100

Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword.

You can also use closing keywords in a commit message. The issue will be closed when you merge the commit into the default branch, but the pull request that contains the commit will not be listed as a linked pull request.

Manually linking a pull request to an issue using the pull request sidebar

Anyone with write permissions to a repository can manually link a pull request to an issue from the pull request sidebar.

You can manually link up to ten issues to each pull request. The issue and pull request must be in the same repository.

  1. GitHub Enterprise Server 인스턴스에서 리포지토리의 기본 페이지로 이동합니다.

  2. 리포지토리 이름에서 끌어오기 요청을 클릭합니다.

    리포지토리의 기본 페이지 스크린샷입니다. 가로 탐색 모음에서 "끌어오기 요청"이라는 레이블이 있는 탭이 진한 주황색 윤곽선으로 표시되어 있습니다.

  3. In the list of pull requests, click the pull request that you'd like to link to an issue.

  4. 오른쪽 사이드바에서 개발을 클릭합니다.

    문제 사이드바의 스크린샷입니다. "개발"은 진한 주황색으로 표시됩니다.

  5. Click the issue you want to link to the pull request.

Manually linking a pull request or branch to an issue using the issue sidebar

Anyone with write permissions to a repository can manually link a pull request or branch to an issue from the issue sidebar.

You can manually link up to ten issues to each pull request. The issue can be in a different repository than the linked pull request or branch. Your last selected repository will be remembered.

  1. GitHub Enterprise Server 인스턴스에서 리포지토리의 기본 페이지로 이동합니다.

  2. 리포지토리 이름 아래에서 이슈 아이콘을 클릭합니다.

    리포지토리의 기본 페이지 스크린샷입니다. 가로 탐색 모음에서 "문제" 레이블이 지정된 탭이 진한 주황색으로 표시됩니다.

  3. In the list of issues, click the issue that you'd like to link a pull request or branch to.

  4. 오른쪽 사이드바에서 개발을 클릭합니다.

    문제 사이드바의 스크린샷입니다. "개발"은 진한 주황색으로 표시됩니다.

  5. Click the repository containing the pull request or branch you want to link to the issue.

  6. Click the pull request or branch you want to link to the issue.

  7. Click Apply.

Further reading