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 "Changing the default branch."
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 (please note that 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 will also close the referenced pull request.
The syntax for closing keywords depends on whether the issue is in the same repository as the pull request.
| 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 |
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
Anyone with write permissions to a repository can manually link a pull request to an issue.
You can manually link up to ten issues to each pull request. The issue and pull request must be in the same repository.
-
On your GitHub Enterprise Server instance, navigate to the main page of the repository.
-
Under your repository name, click Pull requests.
-
In the list of pull requests, click the pull request that you'd like to link to an issue.
-
In the right sidebar, click Linked issues.
-
Click the issue you want to link to the pull request.
