summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-01-13 12:08:04 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-01-13 12:08:04 +0000
commiteb30dd6e28f6fc9eb8021d205f6ed84511f001e2 (patch)
tree9557e4782c762f4d08f57c9e04991bf988695085 /doc
parentc3ad57034cc1cbd6d0ad02de7ac57f6004440c83 (diff)
downloadgitlab-ce-eb30dd6e28f6fc9eb8021d205f6ed84511f001e2.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/api/graphql/reference/gitlab_schema.graphql5
-rw-r--r--doc/api/graphql/reference/gitlab_schema.json14
-rw-r--r--doc/api/graphql/reference/index.md1
-rw-r--r--doc/api/projects.md14
-rw-r--r--doc/user/discussions/img/suggestion-commit-message-configuration.pngbin0 -> 62700 bytes
-rw-r--r--doc/user/discussions/index.md23
-rw-r--r--doc/user/project/service_desk.md27
-rw-r--r--doc/user/project/settings/index.md1
8 files changed, 82 insertions, 3 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql
index 345172658d2..4c037a00857 100644
--- a/doc/api/graphql/reference/gitlab_schema.graphql
+++ b/doc/api/graphql/reference/gitlab_schema.graphql
@@ -5155,6 +5155,11 @@ type Project {
statistics: ProjectStatistics
"""
+ The commit message used to apply merge request suggestions
+ """
+ suggestionCommitMessage: String
+
+ """
List of project tags
"""
tagList: String
diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json
index 2668ea98fc0..eb6e3f8ef16 100644
--- a/doc/api/graphql/reference/gitlab_schema.json
+++ b/doc/api/graphql/reference/gitlab_schema.json
@@ -1526,6 +1526,20 @@
"deprecationReason": null
},
{
+ "name": "suggestionCommitMessage",
+ "description": "The commit message used to apply merge request suggestions",
+ "args": [
+
+ ],
+ "type": {
+ "kind": "SCALAR",
+ "name": "String",
+ "ofType": null
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ },
+ {
"name": "tagList",
"description": "List of project tags",
"args": [
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md
index 9e053c9cdcb..2b8719f725d 100644
--- a/doc/api/graphql/reference/index.md
+++ b/doc/api/graphql/reference/index.md
@@ -769,6 +769,7 @@ Information about pagination in a connection.
| `printingMergeRequestLinkEnabled` | Boolean | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line |
| `removeSourceBranchAfterMerge` | Boolean | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project |
| `autocloseReferencedIssues` | Boolean | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically |
+| `suggestionCommitMessage` | String | The commit message used to apply merge request suggestions |
| `namespace` | Namespace | Namespace of the project |
| `group` | Group | Group of the project |
| `statistics` | ProjectStatistics | Statistics of the project |
diff --git a/doc/api/projects.md b/doc/api/projects.md
index a856c01eb00..8cfba68acee 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -157,6 +157,7 @@ When the user is authenticated and `simple` is not set this returns something li
"request_access_enabled": false,
"merge_method": "merge",
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
@@ -256,6 +257,7 @@ When the user is authenticated and `simple` is not set this returns something li
"service_desk_enabled": false,
"service_desk_address": null,
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"statistics": {
"commit_count": 12,
"storage_size": 2066080,
@@ -388,6 +390,7 @@ This endpoint supports [keyset pagination](README.md#keyset-based-pagination) fo
"request_access_enabled": false,
"merge_method": "merge",
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
@@ -487,6 +490,7 @@ This endpoint supports [keyset pagination](README.md#keyset-based-pagination) fo
"service_desk_enabled": false,
"service_desk_address": null,
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"statistics": {
"commit_count": 12,
"storage_size": 2066080,
@@ -598,6 +602,7 @@ Example response:
"request_access_enabled": false,
"merge_method": "merge",
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
@@ -694,6 +699,7 @@ Example response:
"service_desk_enabled": false,
"service_desk_address": null,
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"statistics": {
"commit_count": 12,
"storage_size": 2066080,
@@ -844,6 +850,7 @@ GET /projects/:id
"service_desk_enabled": false,
"service_desk_address": null,
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
@@ -1068,6 +1075,7 @@ POST /projects/user/:user_id
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
| `merge_method` | string | no | Set the [merge method](#project-merge-method) used |
| `autoclose_referenced_issues` | boolean | no | Set whether auto-closing referenced issues on default branch |
+| `suggestion_commit_message` | string | no | The commit message used to apply merge request suggestions |
| `remove_source_branch_after_merge` | boolean | no | Enable `Delete source branch` option by default for all new merge requests |
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
@@ -1133,6 +1141,7 @@ PUT /projects/:id
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
| `merge_method` | string | no | Set the [merge method](#project-merge-method) used |
| `autoclose_referenced_issues` | boolean | no | Set whether auto-closing referenced issues on default branch |
+| `suggestion_commit_message` | string | no | The commit message used to apply merge request suggestions |
| `remove_source_branch_after_merge` | boolean | no | Enable `Delete source branch` option by default for all new merge requests |
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
@@ -1265,6 +1274,7 @@ Example responses:
"request_access_enabled": false,
"merge_method": "merge",
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
@@ -1354,6 +1364,7 @@ Example response:
"request_access_enabled": false,
"merge_method": "merge",
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
@@ -1442,6 +1453,7 @@ Example response:
"request_access_enabled": false,
"merge_method": "merge",
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
@@ -1617,6 +1629,7 @@ Example response:
"request_access_enabled": false,
"merge_method": "merge",
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
@@ -1724,6 +1737,7 @@ Example response:
"request_access_enabled": false,
"merge_method": "merge",
"autoclose_referenced_issues": true,
+ "suggestion_commit_message": null,
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
diff --git a/doc/user/discussions/img/suggestion-commit-message-configuration.png b/doc/user/discussions/img/suggestion-commit-message-configuration.png
new file mode 100644
index 00000000000..962bc9b0aed
--- /dev/null
+++ b/doc/user/discussions/img/suggestion-commit-message-configuration.png
Binary files differ
diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md
index 56b4e940665..0a2a9c6d2fa 100644
--- a/doc/user/discussions/index.md
+++ b/doc/user/discussions/index.md
@@ -414,9 +414,8 @@ the Merge Request authored by the user that applied them.
Once the author applies a suggestion, it will be marked with the **Applied** label,
the thread will be automatically resolved, 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.
+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
@@ -444,6 +443,24 @@ Suggestions covering multiple lines are limited to 100 lines _above_ and 100
lines _below_ the commented diff line, allowing up to 200 changed lines per
suggestion.
+### Configure the commit message for applied suggestions
+
+GitLab will use `Apply suggestion to %{file_path}` by default as commit messages
+when applying change suggestions. This commit message can be customized to
+follow any guidelines you might have. To do so, open the **Merge requests** tab
+within your project settings and change the **Merge suggestions** text.
+
+![Suggestion Commit Message Configuration](img/suggestion-commit-message-configuration.png)
+
+You can also use following variables besides static text:
+
+- `%{project_path}`: The full URL safe project path. E.g: *my-group/my-project*
+- `%{project_name}`: The human readable name of the project. E.g: *My Project*
+- `%{file_path}`: The full path of the file the suggestion is applied to. E.g: *docs/index.md*
+- `%{branch_name}`: The name of the branch the suggestion is applied on. E.g: *my-feature-branch*
+- `%{username}`: The username of the user applying the suggestion. E.g: *user_1*
+- `%{user_full_name}`: The full name of the user applying the suggestion. E.g: *User 1*
+
## Start a thread by replying to a standard comment
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/30299) in GitLab 11.9
diff --git a/doc/user/project/service_desk.md b/doc/user/project/service_desk.md
index 59c67cdda2f..e9fce474040 100644
--- a/doc/user/project/service_desk.md
+++ b/doc/user/project/service_desk.md
@@ -81,6 +81,33 @@ navigation's **Issues** menu.
![Service Desk Navigation Item](img/service_desk_nav_item.png)
+### Using customized email templates
+
+ > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/2460) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.7.
+
+When a user submits a new issue using Service Desk, or when a new note is created on a Service Desk issue, an email is sent to the author.
+
+The body of these email messages can customized by using templates. To create a new customized template,
+create a new Markdown (`.md`) file inside the `.gitlab/service_desk_templates/`
+directory in your repository. Commit and push to your default branch.
+
+#### Thank you email
+
+The **Thank you email** is the email sent to a user after they submit an issue.
+The file name of the template has to be `thank_you.md`.
+You can use `%{ISSUE_ID}` placeholder which will be replaced by an issue iid in the email and
+`%{ISSUE_PATH}` placeholder which will be replaced by project path and the issue iid.
+As the service desk issues are created as confidential (only project members can see them)
+the response email doesn't provide the issue link.
+
+#### New note email
+
+The **New note email** is the email sent to a user when the issue they submitted has a new comment.
+The file name of the template has to be `new_note.md`.
+You can use `%{ISSUE_ID}` placeholder which will be replaced by an issue iid
+in the email, `%{ISSUE_PATH}` placeholder which will be replaced by
+ project path and the issue iid and `%{NOTE_TEXT}` placeholder which will be replaced by the note text.
+
## Using Service Desk
### As an end user (issue creator)
diff --git a/doc/user/project/settings/index.md b/doc/user/project/settings/index.md
index f68ca90e235..8fa005cc39c 100644
--- a/doc/user/project/settings/index.md
+++ b/doc/user/project/settings/index.md
@@ -91,6 +91,7 @@ Set up your project's merge request settings:
- Enable [merge only if pipeline succeeds](../merge_requests/merge_when_pipeline_succeeds.md).
- Enable [merge only when all threads are resolved](../../discussions/index.md#only-allow-merge-requests-to-be-merged-if-all-threads-are-resolved).
- Enable [`delete source branch after merge` option by default](../merge_requests/getting_started.md#deleting-the-source-branch)
+- Configure [suggested changes commit messages](../../discussions/index.md#configure-the-commit-message-for-applied-suggestions)
![project's merge request settings](img/merge_requests_settings.png)