quick_actions.md 6.3 KB
Newer Older
1 2
# GitLab quick actions

3
Quick actions are textual shortcuts for common actions on issues, epics, merge requests,
4 5
and commits 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, or
6
in comments of issues, epics, merge requests, and commits. Each command should be
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
on a separate line in order to be properly detected and executed. Once executed,
the commands are removed from the text body and not visible to anyone else.

## Quick actions for issues and merge requests

The following quick actions are applicable to both issues and merge requests threads,
discussions, and descriptions:

| Command                    | Action                         | Issue | Merge request |
|:---------------------------|:------------------------------ |:------|:--------------|
| `/tableflip <Comment>`     | Append the comment with `(╯°□°)╯︵ ┻━┻` | ✓ | ✓        |
| `/shrug <Comment>`         | Append the comment with `¯\_(ツ)_/¯` | ✓ | ✓         |
| `/todo`                    | Add a todo                     | ✓     | ✓             |
| `/done`                    | Mark todo as done              | ✓     | ✓             |
| `/subscribe`               | Subscribe                      | ✓     | ✓             |
| `/unsubscribe`             | Unsubscribe                    | ✓     | ✓             |
| `/close`                   | Close                          | ✓     | ✓             |
| `/reopen`                  | Reopen                         | ✓     | ✓             |
| `/title <New title>`       | Change title                   | ✓     |  ✓            |
| `/award :emoji:`           | Toggle emoji award             | ✓     | ✓             |
27
| `/assign me`               | Assign yourself                | ✓     | ✓             |
28
| `/assign @user`            | Assign one user                | ✓     | ✓             |
29 30 31 32
| `/assign @user1 @user2`    | Assign multiple users **[STARTER]** | ✓ | ✓            |
| `/unassign @user1 @user2`  | Remove assignee(s) **[STARTER]** | ✓     | ✓             |
| `/reassign @user1 @user2`  | Change assignee **[STARTER]**  | ✓     | ✓             |
| `/unassign`                | Remove current assignee        | ✓     | ✓             |
33 34
| `/milestone %milestone`    | Set milestone                  | ✓     | ✓             |
| `/remove_milestone`        | Remove milestone               | ✓     | ✓             |
35
| `/label ~label1 ~label2`   | Add label(s). Label names can also start without ~ but mixed syntax is not supported.                   | ✓     | ✓             |
36 37 38 39 40 41 42
| `/unlabel ~label1 ~label2` | Remove all or specific label(s)| ✓     | ✓             |
| `/relabel ~label1 ~label2` | Replace label                  | ✓     | ✓             |
| <code>/copy_metadata #issue &#124; !merge_request</code> | Copy labels and milestone from other issue or merge request | ✓     | ✓             |
| <code>/estimate &lt;1w 3d 2h 14m&gt;</code> | Set time estimate | ✓     | ✓             |
| `/remove_estimate`       | Remove time estimate             | ✓     | ✓             |
| <code>/spend &lt;time(1h 30m &#124; -1h 5m)&gt; &lt;date(YYYY-MM-DD)&gt;</code> | Add or subtract spent time; optionally, specify the date that time was spent on | ✓     | ✓             |
| `/remove_time_spent`       | Remove time spent              | ✓     | ✓             |
Victor Wu's avatar
Victor Wu committed
43 44 45
| `/lock`                    | Lock the discussion            | ✓     | ✓             |
| `/unlock`                  | Unlock the discussion          | ✓     | ✓             |
| <code>/due &lt;in 2 days &#124; this Friday &#124; December 31st&gt;</code>| Set due date | ✓ | |
46 47 48 49 50 51 52 53 54 55 56
| `/remove_due_date`         | Remove due date                | ✓     |               |
| `/weight 0,1,2, ...`       | Set weight **[STARTER]**       | ✓     |               |
| `/clear_weight`            | Clears weight **[STARTER]**    | ✓     |               |
| `/epic <group&epic &#124; Epic URL>` | Add to epic **[ULTIMATE]** | ✓ |             |
| `/remove_epic`             | Removes from epic **[ULTIMATE]** | ✓   |               |
| `/confidential`            | Make confidential              | ✓     |               |
| `/duplicate #issue`        | Mark this issue as a duplicate of another issue | ✓    |
| `/move path/to/project`    | Move this issue to another project | ✓ |               |
| `/target_branch <Local branch Name>` | Set target branch    |       | ✓             |
| `/wip`                     | Toggle the Work In Progress status |   | ✓             |
| `/merge`                   | Merge (when pipeline succeeds) |       | ✓             |
57
| `/create_merge_request <branch name>` | Create a new merge request starting from the current issue | ✓ | |
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

## Quick actions for commit messages

The following quick actions are applicable for commit messages:

| Command                 | Action                                    |
|:------------------------|:------------------------------------------|
| `/tag v1.2.3 <message>` | Tags this commit with an optional message |

## Quick actions for Epics **[ULTIMATE]**

The following quick actions are applicable for epics threads and description:

| Command                    | Action                                  |
|:---------------------------|:----------------------------------------|
| `/tableflip <Comment>`     | Append the comment with `(╯°□°)╯︵ ┻━┻` |
| `/shrug <Comment>`         | Append the comment with `¯\_(ツ)_/¯`  |
75
| `/todo`                    | Add a todo                              |
76 77 78 79 80 81 82 83 84
| `/done`                    | Mark todo as done                       |
| `/subscribe`               | Subscribe                               |
| `/unsubscribe`             | Unsubscribe                             |
| `/close`                   | Close                                   |
| `/reopen`                  | Reopen                                  |
| `/title <New title>`       | Change title                            |
| `/award :emoji:`           | Toggle emoji award                      |
| `/label ~label1 ~label2`   | Add label(s)                            |
| `/unlabel ~label1 ~label2` | Remove all or specific label(s)         |
85
| `/relabel ~label1 ~label2` | Replace label                           |