Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
862c5635
Commit
862c5635
authored
Dec 18, 2018
by
Jacques Erasmus
Committed by
Achilleas Pipinellis
Dec 18, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Suggest diff line change documentation
parent
aa343d54
Changes
7
Show whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
92 additions
and
0 deletions
+92
-0
doc/api/suggestions.md
doc/api/suggestions.md
+36
-0
doc/user/discussions/img/insert_suggestion.png
doc/user/discussions/img/insert_suggestion.png
+0
-0
doc/user/discussions/img/make_suggestion.png
doc/user/discussions/img/make_suggestion.png
+0
-0
doc/user/discussions/img/suggestion.png
doc/user/discussions/img/suggestion.png
+0
-0
doc/user/discussions/index.md
doc/user/discussions/index.md
+45
-0
doc/user/permissions.md
doc/user/permissions.md
+1
-0
doc/user/project/merge_requests/index.md
doc/user/project/merge_requests/index.md
+10
-0
No files found.
doc/api/suggestions.md
0 → 100644
View file @
862c5635
# Suggest Changes API
Every API call to suggestions must be authenticated.
## Applying suggestions
Applies a suggested patch in a merge request. Users must be
at least
[
Developer
](
../user/permissions.md
)
to perform such action.
```
PUT /suggestions/:id/apply
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer/string | yes | The ID of a suggestion |
```
bash
curl
--request
PUT
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
https://gitlab.example.com/api/v4/suggestions/5/apply
```
Example response:
```
json
{
"id"
:
36
,
"from_original_line"
:
10
,
"to_original_line"
:
10
,
"from_line"
:
10
,
"to_line"
:
10
,
"appliable"
:
false
,
"applied"
:
true
,
"from_content"
:
"
\"
--talk-name=org.freedesktop.
\"
,
\n
"
,
"to_content"
:
"
\"
--talk-name=org.free.
\"
,
\n
\"
--talk-name=org.desktop.
\"
,
\n
"
}
```
doc/user/discussions/img/insert_suggestion.png
0 → 100644
View file @
862c5635
19.4 KB
doc/user/discussions/img/make_suggestion.png
0 → 100644
View file @
862c5635
27.8 KB
doc/user/discussions/img/suggestion.png
0 → 100644
View file @
862c5635
38.8 KB
doc/user/discussions/index.md
View file @
862c5635
...
...
@@ -293,6 +293,51 @@ Once you select one of the filters in a given issue or MR, GitLab will save
your preference, so that it will persist when you visit the same page again
from any device you're logged into.
## Suggest Changes
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/18008) in GitLab 11.6.
As a reviewer, you're able to suggest code changes with a simple
markdown syntax in Merge Request Diff discussions. Then, the
Merge Request author (or other users with appropriate
[
permission
](
../permissions.md
)
) is able to apply these
suggestions with a click, which will generate a commit in
the Merge Request authored by the user that applied them.
1.
Choose a line of code to be changed, add a new comment, then click
on the
**Insert suggestion**
icon in the toolbar:
![Add a new comment](img/insert_suggestion.png)
> **Note:**
The suggestion will only affect the commented line. Multi-line
suggestions are currently not supported. Will be introduced by
[#53310](https://gitlab.com/gitlab-org/gitlab-ce/issues/53310).
1.
In the comment, add your suggestion to the pre-populated code block:
![Add a suggestion into a code block tagged properly](img/make_suggestion.png)
1.
Click
**Comment**
.
The suggestions in the comment can be applied by the merge request author
directly from the merge request:
![Apply suggestions](img/suggestion.png)
> **Note:**
Discussions are _not_ automatically resolved. Will be introduced by
[#54405](https://gitlab.com/gitlab-org/gitlab-ce/issues/54405).
Once the author applies a suggestion, it will be marked with the
**Applied**
label,
and GitLab will create a new commit with the message
`Apply suggestion to <file-name>`
and push the suggested change directly into the codebase in the merge request's branch.
[
Developer permission
](
../permissions.md
)
is required to do so.
> **Note:**
Custom commit messages will be introduced by
[
#54404
](
https://gitlab.com/gitlab-org/gitlab-ce/issues/54404
)
.
[
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
...
...
doc/user/permissions.md
View file @
862c5635
...
...
@@ -79,6 +79,7 @@ The following table depicts the various user permission levels in a project.
| View approved/blacklisted licenses
**[ULTIMATE]**
| | | ✓ | ✓ | ✓ |
| Use security dashboard
**[ULTIMATE]**
| | | ✓ | ✓ | ✓ |
| Dismiss vulnerability
**[ULTIMATE]**
| | | ✓ | ✓ | ✓ |
| Apply code change suggestions | | | ✓ | ✓ | ✓ |
| Use environment terminals | | | | ✓ | ✓ |
| Add new team members | | | | ✓ | ✓ |
| Push to protected branches | | | | ✓ | ✓ |
...
...
doc/user/project/merge_requests/index.md
View file @
862c5635
...
...
@@ -150,6 +150,16 @@ in a Merge Request. To do so, click the **...** button in the gutter of the Merg
![
Comment on any diff file line
](
img/comment-on-any-diff-line.png
)
## Suggest changes
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/18008) in GitLab 11.6.
As a reviewer, you can add suggestions to change the content in
merge request discussions, and users with appropriate
[
permission
](
../../permissions.md
)
can easily apply them to the codebase directly from the UI. Read
through the documentation on
[
Suggest changes
](
../../discussions/index.md#suggest-changes
)
to learn more.
## Resolve conflicts
When a merge request has conflicts, GitLab may provide the option to resolve
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment