Commit dd2dab7e authored by Victor Wu's avatar Victor Wu

Merge branch 'docs-quick-actions-table' into 'master'

Quick actions docs table

See merge request gitlab-org/gitlab-ee!7599
parents 8b5a2d5c d190c202
# GitLab quick actions # GitLab quick actions
Quick actions are textual shortcuts for common actions on issues, merge requests Quick actions are textual shortcuts for common actions on issues, epics, merge requests,
or commits that are usually done by clicking buttons or dropdowns in GitLab's UI. 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, and You can enter these commands while creating a new issue or merge request, or
in comments. Each command should be on a separate line in order to be properly in comments of issues, epics, merge requests, and commits. Each command should be
detected and executed. The commands are removed from the issue, merge request or on a separate line in order to be properly detected and executed. Once executed,
comment body before it is saved and will not be visible to anyone else. the commands are removed from the text body and not visible to anyone else.
Below is a list of all of the available commands and descriptions about what they Below is a list of all of the available commands, where they apply, and descriptions
do. about what they do.
| Command | Action | docs-quick-actions-table
|:---------------------------|:-------------|
| `/close` | Close the issue, merge request or epic |
| `/reopen` | Reopen the issue, merge request or epic |
| `/merge` | Merge (when pipeline succeeds) | | Command | Action | Issue | Epic | Merge request | Commit |
| `/title <New title>` | Change title | |:---------------------------|:-----------------------|:------|:-----|:--------------|:-------|
| `/assign @user1 @user2 ` | Add assignee(s) | | `/close` | Close | ✓ | ✓ | ✓ | |
| `/reassign @user1 @user2 ` | Change assignee(s) | | `/reopen` | Reopen | ✓ | ✓ | ✓ | |
| `/unassign @user1 @user2` | Remove all or specific assignee(s) | | `/merge` | Merge (when pipeline succeeds) | | | ✓ | |
| `/milestone %milestone` | Set milestone | | `/title <New title>` | Change title | | ✓ | ✓ | ✓ | |
| `/remove_milestone` | Remove milestone | | `/assign @username` | Assign | ✓ | | ✓ | |
| `/label ~foo ~"bar baz"` | Add label(s) | | `/unassign` | Remove assignee | ✓ | | ✓ | |
| `/unlabel ~foo ~"bar baz"` | Remove all or specific label(s) | | `/milestone %milestone` | Set milestone | ✓ | | ✓ | |
| `/relabel ~foo ~"bar baz"` | Replace all label(s) | | `/remove_milestone` | Remove milestone | ✓ | | ✓ | |
| `/todo` | Add a todo | | `/label ~foo ~"bar baz"` | Add label(s) | ✓ | | ✓ | |
| `/done` | Mark todo as done | | `/unlabel ~foo ~"bar baz"` | Remove all or specific label(s)| ✓ | | ✓ | |
| `/subscribe` | Subscribe | | `/relabel ~foo ~"bar baz"` | Replace all label(s) | ✓ | | ✓ | |
| `/unsubscribe` | Unsubscribe | | `/todo` | Add a todo | ✓ | ✓ | ✓ | |
| <code>/due &lt;in 2 days &#124; this Friday &#124; December 31st&gt;</code> | Set due date | | `/done` | Mark todo as done | ✓ | ✓ | ✓ | |
| `/remove_due_date` | Remove due date | | `/subscribe` | Subscribe | ✓ | ✓ | ✓ | |
| `/wip` | Toggle the Work In Progress status | | `/unsubscribe` | Unsubscribe | ✓ | ✓ | ✓ | |
| <code>/estimate &lt;1w 3d 2h 14m&gt;</code> | Set time estimate | | <code>/due &lt;in 2 days &#124; this Friday &#124; December 31st&gt;</code> | Set due date | ✓ | | | |
| `/remove_estimate` | Remove estimated time | | `/remove_due_date` | Remove due date | ✓ | | | |
| <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 | | `/wip` | Toggle the Work In Progress status | | | ✓ | |
| `/remove_time_spent` | Remove time spent | | <code>/estimate &lt;1w 3d 2h 14m&gt;</code> | Set time estimate | ✓ | | ✓ | |
| `/target_branch <Branch Name>` | Set target branch for current merge request | | `/remove_estimate` | Remove estimated time | ✓ | | ✓ | |
| `/award :emoji:` | Toggle award for :emoji: | | <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 | ✓ | | | ✓ |
| `/weight <0-999999999>` | Set the weight of the issue | | `/remove_time_spent` | Remove time spent | ✓ | | ✓ | |
| `/clear_weight` | Clears the issue weight | | `/target_branch <Branch Name>` | Set target branch for current merge request | | | ✓ | |
| `/board_move ~column` | Move issue to column on the board | | `/award :emoji:` | Toggle award for :emoji: | ✓ | ✓ | ✓ | |
| `/duplicate #issue` | Closes this issue and marks it as a duplicate of another issue | | `/weight <0-999999999>` | Set the weight of the issue | ✓ | | | |
| `/move path/to/project` | Moves issue to another project | | `/clear_weight` | Clears the issue weight | ✓ | | | |
| `/tag v1.2.3 <message>` | Tags a commit with a given tag name and optional message | | `/board_move ~column` | Move issue to column on the board | ✓ | | | |
| `/tableflip` | Append the comment with `(╯°□°)╯︵ ┻━┻` | | `/duplicate #issue` | Closes this issue and marks it as a duplicate of another issue | ✓ | | | |
| `/shrug` | Append the comment with `¯\_(ツ)_/¯` | | `/move path/to/project` | Moves issue to another project | ✓ | | | |
| <code>/copy_metadata #issue &#124; !merge_request</code> | Copy labels and milestone from other issue or merge request | | `/tag v1.2.3 <message>` | Tags a commit with a given tag name and optional message | | | | ✓ |
| `/confidential` | Makes the issue confidential | | `/tableflip` | Append the comment with `(╯°□°)╯︵ ┻━┻` | ✓ | ✓ | ✓ | ✓ |
| `/epic <group&epic | Epic URL>` | Adds an issue to an epic | | `/shrug` | Append the comment with `¯\_(ツ)_/¯` | ✓ | ✓ | ✓ | ✓ |
| `/remove_epic` | Removes an issue from an epic | | <code>/copy_metadata #issue &#124; !merge_request</code> | Copy labels and milestone from other issue or merge request | ✓ | | ✓ | |
| `/lock` | Lock the discussion | | `/confidential` | Makes the issue confidential | ✓ | | | |
| `/unlock` | Unlock the discussion | | `/epic <group&epic OR Epic URL>` | Adds an issue to an epic | | ✓ | | |
| `/remove_epic` | Removes an issue from an epic | | ✓ | | |
| `/lock` | Lock the discussion | ✓ | | | ✓ |
| `/unlock` | Unlock the discussion | ✓ | | | ✓|
Note: In GitLab Starter every issue can have more than one assignee, so commands `/assign`, `/unassign` and `/reassign` Note: In GitLab Starter every issue can have more than one assignee, so commands `/assign`, `/unassign` and `/reassign`
support multiple assignees. support multiple assignees.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment