Article version: Enterprise Server 2.17
Linking a pull request to an issue
You can link a pull request to an issue to automatically close the issue when the pull request is merged.
About linked issues and pull requests
You can link an issue to a pull request using a supported keyword in the pull request description.
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 "Setting 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.
- close
- closes
- closed
- fix
- fixes
- fixed
- resolve
- resolves
- resolved
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 |
You can also use closing keywords in a commit message. The issue will be closed when you merge the commit into the default branch.