index.md 6.46 KB
Newer Older
1
# Discussions
2

3 4
The ability to contribute conversationally is offered throughout GitLab.

5
You can leave a comment in the following places:
6

7 8 9 10 11
- issues
- merge requests
- snippets
- commits
- commit diffs
12

13
The comment area supports [Markdown] and [quick actions]. One can edit their
14
own comment at any time, and anyone with [Master access level][permissions] or
15
higher can also edit a comment made by someone else.
16

17 18 19 20 21 22 23 24
Apart from the standard comments, you also have the option to create a comment
in the form of a resolvable or threaded discussion.

## Resolvable discussions

>**Notes:**
- The main feature was [introduced][ce-5022] in GitLab 8.11.
- Resolvable discussions can be added only to merge request diffs.
25 26

Discussion resolution helps keep track of progress during planning or code review.
27 28 29 30 31 32
Resolving comments prevents you from forgetting to address feedback and lets you
hide discussions that are no longer relevant.

!["A discussion between two people on a piece of code"][discussion-view]

Comments and discussions can be resolved by anyone with at least Developer
33
access to the project or the author of the merge request.
34

35 36 37 38 39 40 41 42 43 44 45
### Jumping between unresolved discussions

When a merge request has a large number of comments it can be difficult to track
what remains unresolved. You can jump between unresolved discussions with the
Jump button next to the Reply field on a discussion.

You can also jump to the first unresolved discussion from the button next to the
resolved discussions tracker.

!["3/4 discussions resolved"][discussions-resolved]

46
### Marking a comment or discussion as resolved
47

48
You can mark a discussion as resolved by clicking the **Resolve discussion**
49 50 51 52 53 54 55 56
button at the bottom of the discussion.

!["Resolve discussion" button][resolve-discussion-button]

Alternatively, you can mark each comment as resolved individually.

!["Resolve comment" button][resolve-comment-button]

57
### Move all unresolved discussions in a merge request to an issue
58 59 60

> [Introduced][ce-8266] in GitLab 9.1

61 62
To continue all open discussions from a merge request in a new issue, click the
**Resolve all discussions in new issue** button.
63

64
![Open new issue for all unresolved discussions](img/btn_new_issue_for_all_discussions.png)
65

66 67 68 69
Alternatively, when your project only accepts merge requests [when all discussions
are resolved](#only-allow-merge-requests-to-be-merged-if-all-discussions-are-resolved),
there will be an **open an issue to resolve them later** link in the merge
request widget.
70

71
![Link in merge request widget](img/resolve_discussion_open_issue.png)
72

73 74
This will prepare an issue with its content referring to the merge request and
the unresolved discussions.
75

76
![Issue mentioning discussions in a merge request](img/preview_issue_for_discussions.png)
77

78 79
Hitting **Submit issue** will cause all discussions to be marked as resolved and
add a note referring to the newly created issue.
80

81
![Mark discussions as resolved notice](img/resolve_discussion_issue_notice.png)
82

83
You can now proceed to merge the merge request from the UI.
84

85
### Moving a single discussion to a new issue
86

87
> [Introduced][ce-8266] in GitLab 9.1
88

89 90
To create a new issue for a single discussion, you can use the **Resolve this
discussion in a new issue** button.
91

92
![Create issue for discussion](img/new_issue_for_discussion.png)
93

94 95 96 97 98 99
This will direct you to a new issue prefilled with the content of the
discussion, similar to the issues created for delegating multiple
discussions at once. Saving the issue will mark the discussion as resolved and
add a note to the merge request discussion referencing the new issue.

![New issue for a single discussion](img/preview_issue_for_discussion.png)
100

101
### Only allow merge requests to be merged if all discussions are resolved
102 103 104

> [Introduced][ce-7125] in GitLab 8.14.

105 106
You can prevent merge requests from being merged until all discussions are
resolved.
107 108 109 110 111 112 113 114 115 116 117 118

Navigate to your project's settings page, select the
**Only allow merge requests to be merged if all discussions are resolved** check
box and hit **Save** for the changes to take effect.

![Only allow merge if all the discussions are resolved settings](img/only_allow_merge_if_all_discussions_are_resolved.png)

From now on, you will not be able to merge from the UI until all discussions
are resolved.

![Only allow merge if all the discussions are resolved message](img/only_allow_merge_if_all_discussions_are_resolved_msg.png)

119
### Automatically resolve merge request diff discussions when they become outdated
120

121
> [Introduced][ce-14053] in GitLab 10.0.
122

123 124 125 126 127
You can automatically resolve merge request diff discussions on lines modified
with a new push.

Navigate to your project's settings page, select the **Automatically resolve
merge request diffs discussions on lines changed with a push** check box and hit
128 129
**Save** for the changes to take effect.

130
![Automatically resolve merge request diff discussions when they become outdated](img/automatically_resolve_outdated_discussions.png)
131

132 133 134
From now on, any discussions on a diff will be resolved by default if a push
makes that diff section outdated. Discussions on lines that don't change and
top-level resolvable discussions are not automatically resolved.
135

136
## Threaded discussions
137

138
> [Introduced][ce-7527] in GitLab 9.1.
139

140 141 142 143
While resolvable discussions are only available to merge request diffs,
discussions can also be added without a diff. You can start a specific
discussion which will look like a thread, on issues, commits, snippets, and
merge requests.
144

145 146 147
To start a threaded discussion, click on the **Comment** button toggle dropdown,
select **Start discussion** and click **Start discussion** when you're ready to
post the comment.
148 149 150

![Comment type toggle](img/comment_type_toggle.gif)

151 152
This will post a comment with a single thread to allow you to discuss specific
comments in greater detail.
153 154

![Discussion comment](img/discussion_comment.png)
155 156 157 158 159 160

[ce-5022]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5022
[ce-7125]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7125
[ce-7527]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7527
[ce-7180]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7180
[ce-8266]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8266
161
[ce-14053]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14053
162 163 164 165 166
[resolve-discussion-button]: img/resolve_discussion_button.png
[resolve-comment-button]: img/resolve_comment_button.png
[discussion-view]: img/discussion_view.png
[discussions-resolved]: img/discussions_resolved.png
[markdown]: ../markdown.md
167
[quick actions]: ../project/quick_actions.md
168
[permissions]: ../permissions.md