debian-mirror-gitlab/doc/user/project/issues/related_issues.md

71 lines
2.9 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
stage: Plan
group: Project Management
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-06-23 00:09:42 +05:30
---
2021-03-11 19:13:27 +05:30
# Related issues **(FREE)**
2019-07-31 22:56:46 +05:30
2021-01-03 14:25:43 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1797) in [GitLab Starter](https://about.gitlab.com/pricing/) 9.4.
2021-03-11 19:13:27 +05:30
> - The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) to [GitLab Free](https://about.gitlab.com/pricing/) in 13.4.
2019-07-31 22:56:46 +05:30
Related issues are a bi-directional relationship between any two issues
and appear in a block below the issue description. Issues can be across groups
and projects.
2021-01-03 14:25:43 +05:30
You can set any issue as:
- Related to another issue
- Blocking another issue **(STARTER)**
- Blocked by another issue **(STARTER)**
2019-07-31 22:56:46 +05:30
The relationship only shows up in the UI if the user can see both issues.
2020-10-24 23:57:45 +05:30
When you try to close an issue that has open blockers, a warning is displayed.
2021-02-22 17:27:13 +05:30
NOTE:
2021-01-03 14:25:43 +05:30
To manage related issues through our API, visit the [issue links API documentation](../../../api/issue_links.md).
2020-10-24 23:57:45 +05:30
2019-07-31 22:56:46 +05:30
## Adding a related issue
2020-05-24 23:13:21 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2035) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.8.
2020-10-24 23:57:45 +05:30
> - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/34239) to warn when attempting to close an issue that is blocked by others in [GitLab Starter](https://about.gitlab.com/pricing/) 13.0.
2021-01-03 14:25:43 +05:30
> When you try to close an issue with open blockers, you see a warning that you can dismiss.
2020-05-24 23:13:21 +05:30
2020-10-24 23:57:45 +05:30
1. Relate one issue to another by clicking the related issues "+" button
in the header of the related issue block.
1. Input the issue reference number or paste in the full URL of the issue.
2019-07-31 22:56:46 +05:30
2021-01-03 14:25:43 +05:30
1. **(STARTER)** Select whether the current issue relates to, blocks, or is blocked by the issues being entered.
2020-03-13 15:44:24 +05:30
2020-10-24 23:57:45 +05:30
![Adding a related issue](img/related_issues_add_v12_8.png)
2020-03-13 15:44:24 +05:30
2020-10-24 23:57:45 +05:30
Issues of the same project can be specified just by the reference number.
Issues from a different project require additional information like the
group and the project name. For example:
2019-07-31 22:56:46 +05:30
2020-10-24 23:57:45 +05:30
- same project: `#44`
- same group: `project#44`
- different group: `group/project#44`
2019-07-31 22:56:46 +05:30
2021-01-03 14:25:43 +05:30
Valid references are added to a temporary list that you can review.
2020-03-13 15:44:24 +05:30
2020-10-24 23:57:45 +05:30
1. When you have added all the related issues, click **Add** to submit.
2021-01-03 14:25:43 +05:30
When you have finished adding all related issues, you can see
2020-03-13 15:44:24 +05:30
them categorized so their relationships can be better understood visually.
2019-07-31 22:56:46 +05:30
2020-03-13 15:44:24 +05:30
![Related issue block](img/related_issue_block_v12_8.png)
2019-07-31 22:56:46 +05:30
## Removing a related issue
In the related issues block, click the "x" icon on the right-side of each issue
2020-10-24 23:57:45 +05:30
token that you wish to remove.
2021-01-03 14:25:43 +05:30
Due to the bi-directional relationship, it no longer appears in either issue.
2019-07-31 22:56:46 +05:30
2020-03-13 15:44:24 +05:30
![Removing a related issue](img/related_issues_remove_v12_8.png)
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
Please access our [permissions](../../permissions.md) page for more information.