jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 11:54:18 -05:00
Code Issues Projects Releases Wiki Activity

Update linking-a-pull-request-to-an-issue.md

Browse Source 
Fixes #165 . I added a Note box at the end of the document, and a reference to it at the top of the document - should be enough warning without disrupting the rest of the text. Also changed the introdutory line in the "Linking a pull request(...)" section as suggested by the author.
This commit is contained in:
Arthur Casals
2020-10-07 23:26:40 +02:00
committed by GitHub
parent be3a96561b
commit 66f835fbab
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
content/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue.md
View File

@@ -13,7 +13,7 @@ versions:
### About linked issues and pull requests ### About linked issues and pull requests
You can link an issue to a pull request {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}manually or {% endif %}using a supported keyword in the pull request description. You can link an issue to a pull request {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}manually or {% endif %}using a supported keyword in the pull request description. **Important:** this only happens when the PR base branch is the repository default branch (see **Note** below).
When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. {% if currentVersion ver_lt "enterprise-server@2.21" %}If the pull request and the issue are in different repositories, {% data variables.product.product_name %} will display the link after the pull request is merged, if the person who merges the pull request also has permission to close the issue.{% endif %} When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. {% if currentVersion ver_lt "enterprise-server@2.21" %}If the pull request and the issue are in different repositories, {% data variables.product.product_name %} will display the link after the pull request is merged, if the person who merges the pull request also has permission to close the issue.{% endif %}
@@ -37,7 +37,7 @@ You can manually link up to ten issues to each pull request. The issue and pull
### Linking a pull request to an issue using a keyword ### 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. 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.
* close * close
* closes * closes
@@ -61,6 +61,13 @@ Multiple issues | Use full syntax for each issue | `Resolves #10, resolves #123,
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. 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.
---
**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.**
---
### Further reading ### Further reading
- "[Autolinked references and URLs](/articles/autolinked-references-and-urls/#issues-and-pull-requests)" - "[Autolinked references and URLs](/articles/autolinked-references-and-urls/#issues-and-pull-requests)"