summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Speicher <rspeicher@gmail.com>2016-08-18 16:38:42 -0500
committerRobert Speicher <rspeicher@gmail.com>2016-08-18 16:41:16 -0500
commit717366d28da11acc6dbe60301bf7e2394400b3c1 (patch)
treeba3a95c9bf1627519c00dab30562d5cd4f646857 /doc
parentd97c83096a70ed102f993d4c484aff9c786ca831 (diff)
parent2703330a19e813351e9c33241a59d6b7f54741df (diff)
downloadgitlab-ce-717366d28da11acc6dbe60301bf7e2394400b3c1.tar.gz
Merge branch '4273-slash-commands' into 'master'
Support slash commands in issues / MR description & comments See merge request !5021
Diffstat (limited to 'doc')
-rw-r--r--doc/workflow/README.md1
-rw-r--r--doc/workflow/slash_commands.md30
2 files changed, 31 insertions, 0 deletions
diff --git a/doc/workflow/README.md b/doc/workflow/README.md
index 3055411c484..1653d95e722 100644
--- a/doc/workflow/README.md
+++ b/doc/workflow/README.md
@@ -7,6 +7,7 @@
- [GitLab Flow](gitlab_flow.md)
- [Groups](groups.md)
- [Keyboard shortcuts](shortcuts.md)
+- [Slash commands](slash_commands.md)
- [File finder](file_finder.md)
- [Labels](../user/project/labels.md)
- [Notification emails](notifications.md)
diff --git a/doc/workflow/slash_commands.md b/doc/workflow/slash_commands.md
new file mode 100644
index 00000000000..91d69d4e77e
--- /dev/null
+++ b/doc/workflow/slash_commands.md
@@ -0,0 +1,30 @@
+# GitLab slash commands
+
+Slash commands are textual shortcuts for common actions on issues or merge
+requests that are usually done by clicking buttons or dropdowns in GitLab's UI.
+You can enter these commands while creating a new issue or merge request, and
+in comments. Each command should be on a separate line in order to be properly
+detected and executed. The commands are removed from the issue, merge request or
+comment body before it is saved and will not be visible to anyone else.
+
+Below is a list of all of the available commands and descriptions about what they
+do.
+
+| Command | Action |
+|:---------------------------|:-------------|
+| `/close` | Close the issue or merge request |
+| `/reopen` | Reopen the issue or merge request |
+| `/title <New title>` | Change title |
+| `/assign @username` | Assign |
+| `/unassign` | Remove assignee |
+| `/milestone %milestone` | Set milestone |
+| `/remove_milestone` | Remove milestone |
+| `/label ~foo ~"bar baz"` | Add label(s) |
+| `/unlabel ~foo ~"bar baz"` | Remove all or specific label(s) |
+| `/relabel ~foo ~"bar baz"` | Replace all label(s) |
+| `/todo` | Add a todo |
+| `/done` | Mark todo as done |
+| `/subscribe` | Subscribe |
+| `/unsubscribe` | Unsubscribe |
+| `/due <in 2 days | this Friday | December 31st>` | Set due date |
+| `/remove_due_date` | Remove due date |