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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

84 lines
3.3 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
stage: Plan
2023-01-13 00:05:48 +05:30
group: Product Planning
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-06-23 00:09:42 +05:30
---
2021-04-29 21:17:54 +05:30
# Linked issues **(FREE)**
2019-07-31 22:56:46 +05:30
2022-04-04 11:22:00 +05:30
> The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) from GitLab Premium to GitLab Free in 13.4.
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
Linked issues are a bi-directional relationship between any two issues and appear in a block below
2022-04-04 11:22:00 +05:30
the issue description. You can link issues in different projects.
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
The relationship only shows up in the UI if the user can see both issues. When you try to close an
issue that has open blockers, a warning is displayed.
2020-10-24 23:57:45 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2023-04-23 21:23:45 +05:30
To manage linked issues through our API, see [Issue links API](../../../api/issue_links.md).
2020-10-24 23:57:45 +05:30
2021-04-29 21:17:54 +05:30
## Add a linked issue
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2035) in GitLab 12.8.
> - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/34239) to warn when attempting to close an issue that is blocked by others in GitLab 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
2022-04-04 11:22:00 +05:30
Prerequisites:
2020-10-24 23:57:45 +05:30
2022-04-04 11:22:00 +05:30
- You must have at least the Reporter role for both projects.
To link one issue to another:
2022-10-11 01:57:18 +05:30
1. In the **Linked items** section of an issue,
2022-04-04 11:22:00 +05:30
select the add linked issue button (**{plus}**).
2022-01-26 12:08:38 +05:30
1. Select the relationship between the two issues. Either:
2021-04-29 21:17:54 +05:30
- **relates to**
2022-04-04 11:22:00 +05:30
- **[blocks](#blocking-issues)**
- **[is blocked by](#blocking-issues)**
2021-04-29 21:17:54 +05:30
1. Input the issue number or paste in the full URL of the issue.
2019-07-31 22:56:46 +05:30
2022-08-27 11:52:29 +05:30
![Adding a related issue](img/related_issues_add_v15_3.png)
2020-03-13 15:44:24 +05:30
2021-04-29 21:17:54 +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:
2020-03-13 15:44:24 +05:30
2021-04-29 21:17:54 +05:30
- The same project: `#44`
- The same group: `project#44`
- Different group: `group/project#44`
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
Valid references are added to a temporary list that you can review.
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
1. When you have added all the linked issues, select **Add**.
2020-03-13 15:44:24 +05:30
2021-04-29 21:17:54 +05:30
When you have finished adding all linked 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
2022-08-27 11:52:29 +05:30
![Related issue block](img/related_issue_block_v15_3.png)
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
You can also add a linked issue from a commit message or the description in another issue or MR.
2023-04-23 21:23:45 +05:30
For more information, see [Crosslinking issues](crosslinking_issues.md).
2021-04-29 21:17:54 +05:30
## Remove a linked issue
2019-07-31 22:56:46 +05:30
2022-10-11 01:57:18 +05:30
In the **Linked items** section of an issue, select the remove button (**{close}**) on the
2021-04-29 21:17:54 +05:30
right-side of each issue token to remove.
2020-10-24 23:57:45 +05:30
2021-04-29 21:17:54 +05:30
Due to the bi-directional relationship, the relationship no longer appears in either issue.
2019-07-31 22:56:46 +05:30
2022-08-27 11:52:29 +05:30
![Removing a related issue](img/related_issues_remove_v15_3.png)
2019-07-31 22:56:46 +05:30
2021-04-29 21:17:54 +05:30
Access our [permissions](../../permissions.md) page for more information.
2022-04-04 11:22:00 +05:30
## Blocking issues **(PREMIUM)**
When you [add a linked issue](#add-a-linked-issue), you can show that it **blocks** or
**is blocked by** another issue.
2022-05-07 20:08:51 +05:30
Issues that block other issues have an icon (**{issue-block}**) next to their title, shown in the
issue lists and [boards](../issue_board.md).
The icon disappears when the blocking issue is closed or their relationship is changed or
[removed](#remove-a-linked-issue).
If you try to close a blocked issue using the "Close issue" button, a confirmation message appears.