gitlab-org--gitlab-foss/doc/user/discussions/index.md
2017-04-24 16:39:47 +00:00

5.6 KiB

Discussions

The ability to contribute conversationally is offered throughout GitLab.

You can leave a comment in the following places:

  • issues
  • merge requests
  • snippets
  • commits
  • commit diffs

The comment area supports Markdown and slash commands. One can edit their own comment at any time, and anyone with Master access level or higher can also edit a comment made by someone else.

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 in GitLab 8.11.
  • Resolvable discussions can be added only to merge request diffs.

Discussion resolution helps keep track of progress during planning or code review. 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"

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

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"

Marking a comment or discussion as resolved

You can mark a discussion as resolved by clicking the Resolve discussion button at the bottom of the discussion.

"Resolve discussion" button

Alternatively, you can mark each comment as resolved individually.

"Resolve comment" button

Move all unresolved discussions in a merge request to an issue

Introduced in GitLab 9.1

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

Open new issue for all unresolved discussions

Alternatively, when your project only accepts merge requests when all discussions are resolved, there will be an open an issue to resolve them later link in the merge request widget.

Link in merge request widget

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

Issue mentioning discussions in a merge request

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

Mark discussions as resolved notice

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

Moving a single discussion to a new issue

Introduced in GitLab 9.1

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

Create issue for discussion

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

Only allow merge requests to be merged if all discussions are resolved

Introduced in GitLab 8.14.

You can prevent merge requests from being merged until all discussions are resolved.

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

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

Threaded discussions

Introduced in GitLab 9.1.

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.

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.

Comment type toggle

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

Discussion comment