Skip to content

G
gitlab-ce
Commit a27ff1cb authored by Victor Wu's avatar Victor Wu
Browse files
Options

Refactor quick actions docs into multiple tables

parent 607f263c
Hide whitespace changes
Inline Side-by-side
Showing with 79 additions and 46 deletions
doc/user/project/quick_actions.md
View file @ a27ff1cb
# 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 ## Quick actions for issues and merge requests
do.
The following quick actions are applicable to both issues and merge requests threads,
| Command | Action | discussions, and descriptions:
|:---------------------------|:-------------|
| `/close` | Close the issue or merge request | | Command | Action | Issue | Merge request |
| `/reopen` | Reopen the issue or merge request | |:---------------------------|:------------------------------ |:------|:--------------|
| `/merge` | Merge (when pipeline succeeds) | | `/tableflip <Comment>` | Append the comment with `(╯°□°)╯︵ ┻━┻` | ✓ | ✓ |
| `/title <New title>` | Change title | | `/shrug <Comment>` | Append the comment with `¯\＿(ツ)＿/¯` | ✓ | ✓ |
| `/assign @username` | Assign | | `/todo` | Add a todo | ✓ | ✓ |
| `/unassign` | Remove assignee | | `/done` | Mark todo as done | ✓ | ✓ |
| `/milestone %milestone` | Set milestone | | `/subscribe` | Subscribe | ✓ | ✓ |
| `/remove_milestone` | Remove milestone | | `/unsubscribe` | Unsubscribe | ✓ | ✓ |
| `/label ~foo ~"bar baz"` | Add label(s) | | `/close` | Close | ✓ | ✓ |
| `/unlabel ~foo ~"bar baz"` | Remove all or specific label(s) | | `/reopen` | Reopen | ✓ | ✓ |
| `/relabel ~foo ~"bar baz"` | Replace all label(s) | | `/title <New title>` | Change title | ✓ | ✓ |
| `/todo` | Add a todo | | `/award :emoji:` | Toggle emoji award | ✓ | ✓ |
| `/done` | Mark todo as done | | `/assign @user` | Assign one user | ✓ | ✓ |
| `/subscribe` | Subscribe | | `/assign @user1 @user2` | Assign multiple users **[STARTER]** | ✓ | |
| `/unsubscribe` | Unsubscribe | | `/unassign` | Remove assignee(s) | ✓ | ✓ |
| <code>/due &lt;in 2 days &#124; this Friday &#124; December 31st&gt;</code> | Set due date | | `/reassign @user1 @user2` | Change assignee | ✓ | ✓ |
| `/remove_due_date` | Remove due date | | `/milestone %milestone` | Set milestone | ✓ | ✓ |
| `/wip` | Toggle the Work In Progress status | | `/remove_milestone` | Remove milestone | ✓ | ✓ |
| <code>/estimate &lt;1w 3d 2h 14m&gt;</code> | Set time estimate | | `/label ~label1 ~label2` | Add label(s) | ✓ | ✓ |
| `/remove_estimate` | Remove estimated time | | `/unlabel ~label1 ~label2` | Remove all or specific label(s)| ✓ | ✓ |
| <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 | | `/relabel ~label1 ~label2` | Replace label | ✓ | ✓ |
| `/remove_time_spent` | Remove time spent | | <code>/copy_metadata #issue &#124; !merge_request</code> | Copy labels and milestone from other issue or merge request | ✓ | ✓ |
| `/target_branch <Branch Name>` | Set target branch for current merge request | | <code>/estimate &lt;1w 3d 2h 14m&gt;</code> | Set time estimate | ✓ | ✓ |
| `/award :emoji:` | Toggle award for :emoji: | | `/remove_estimate` | Remove time estimate | ✓ | ✓ |
| `/board_move ~column` | Move issue to column on the board | | <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 | ✓ | ✓ |
| `/duplicate #issue` | Closes this issue and marks it as a duplicate of another issue | | `/remove_time_spent` | Remove time spent | ✓ | ✓ |
| `/move path/to/project` | Moves issue to another project | | <code>/due &lt;in 2 days &#124; this Friday &#124; December 31st&gt;</code>| Set due date | ✓ |
| `/tag v1.2.3 <message>` | Tags a commit with a given tag name and optional message | | `/remove_due_date` | Remove due date | ✓ | |
| `/tableflip` | Append the comment with `(╯°□°)╯︵ ┻━┻` | | `/weight 0,1,2, ...` | Set weight **[STARTER]** | ✓ | |
| `/shrug` | Append the comment with `¯\＿(ツ)＿/¯` | | `/clear_weight` | Clears weight **[STARTER]** | ✓ | |
| <code>/copy_metadata #issue &#124; !merge_request</code> | Copy labels and milestone from other issue or merge request | | `/epic <group&epic &#124; Epic URL>` | Add to epic **[ULTIMATE]** | ✓ | |
| `/confidential` | Makes the issue confidential | | `/remove_epic` | Removes from epic **[ULTIMATE]** | ✓ | |
| `/lock` | Lock the discussion | | `/confidential` | Make confidential | ✓ | |
| `/unlock` | Unlock the discussion | | `/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) | | ✓ |
## 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 `¯\＿(ツ)＿/¯` |
| `/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 |
| `/label ~label1 ~label2` | Add label(s) |
| `/unlabel ~label1 ~label2` | Remove all or specific label(s) |
| `/relabel ~label1 ~label2` | Replace label |
\ No newline at end of file
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7