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

58 lines
2.4 KiB
Markdown
Raw Normal View History

2017-08-17 22:00:37 +05:30
# Crosslinking Issues
Please read through the [GitLab Issue Documentation](index.md) for an overview on GitLab Issues.
## From Commit Messages
Every time you mention an issue in your commit message, you're creating
a relationship between the two stages of the development workflow: the
issue itself and the first commit related to that issue.
If the issue and the code you're committing are both in the same project,
you simply add `#xxx` to the commit message, where `xxx` is the issue number.
If they are not in the same project, you can add the full URL to the issue
(`https://gitlab.com/<username>/<projectname>/issues/<xxx>`).
```shell
git commit -m "this is my commit message. Ref #xxx"
```
or
```shell
git commit -m "this is my commit message. Related to https://gitlab.com/<username>/<projectname>/issues/<xxx>"
```
Of course, you can replace `gitlab.com` with the URL of your own GitLab instance.
2019-09-30 21:07:59 +05:30
NOTE: **Note:** Linking your first commit to your issue is going to be relevant
2020-04-22 19:07:51 +05:30
for tracking your process with [GitLab Cycle Analytics](https://about.gitlab.com/stages-devops-lifecycle/value-stream-analytics/).
2017-08-17 22:00:37 +05:30
It will measure the time taken for planning the implementation of that issue,
which is the time between creating an issue and making the first commit.
## From Related Issues
Mentioning related issues in merge requests and other issues is useful
for your team members and collaborators to know that there are opened
2019-09-30 21:07:59 +05:30
issues regarding the same topic.
2017-08-17 22:00:37 +05:30
2019-09-30 21:07:59 +05:30
You do that as explained above, when [mentioning an issue from a commit message](#from-commit-messages).
2017-08-17 22:00:37 +05:30
2019-09-30 21:07:59 +05:30
When mentioning issue `#111` in issue `#222`, issue `#111` will also display a notification
in its tracker. That is, you only need to mention the relationship once for it to
display in both issues. The same is valid when mentioning issues in [merge requests](#from-merge-requests).
2017-08-17 22:00:37 +05:30
![issue mentioned in issue](img/mention_in_issue.png)
## From Merge Requests
2019-07-07 11:18:12 +05:30
Mentioning issues in merge request comments works exactly the same way as
2019-09-30 21:07:59 +05:30
they do for [related issues](#from-related-issues).
2017-08-17 22:00:37 +05:30
2019-07-07 11:18:12 +05:30
When you mention an issue in a merge request description, it will simply
[link the issue and merge request together](#from-related-issues). Additionally,
2019-09-30 21:07:59 +05:30
you can also [set an issue to close automatically](managing_issues.md#closing-issues-automatically)
as soon as the merge request is merged.
2017-08-17 22:00:37 +05:30
![issue mentioned in MR](img/mention_in_merge_request.png)