73c6477b7e
Previously, we used brackets to denote the tier badges, but this made Kramdown, the docs site Markdown renderer, show many warnings when building the site. This is now fixed by using parentheses instead of square brackets. This was caused by [PREMIUM] looking like a link to Kramdown, which couldn't find a URL there. See: - https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/484 - https://gitlab.com/gitlab-org/gitlab-ce/issues/63800
92 lines
7.4 KiB
Markdown
92 lines
7.4 KiB
Markdown
# GitLab quick actions
|
||
|
||
Quick actions are textual shortcuts for common actions on issues, epics, merge requests,
|
||
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
|
||
in comments of issues, epics, merge requests, and commits. Each command should be
|
||
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 To Do | ✓ | ✓ |
|
||
| `/done` | Mark To Do as done | ✓ | ✓ |
|
||
| `/subscribe` | Subscribe | ✓ | ✓ |
|
||
| `/unsubscribe` | Unsubscribe | ✓ | ✓ |
|
||
| `/close` | Close | ✓ | ✓ |
|
||
| `/reopen` | Reopen | ✓ | ✓ |
|
||
| `/title <New title>` | Change title | ✓ | ✓ |
|
||
| `/award :emoji:` | Toggle emoji award | ✓ | ✓ |
|
||
| `/assign me` | Assign yourself | ✓ | ✓ |
|
||
| `/assign @user` | Assign one user | ✓ | ✓ |
|
||
| `/assign @user1 @user2` | Assign multiple users **(STARTER)** | ✓ | ✓ |
|
||
| `/unassign @user1 @user2` | Remove assignee(s) **(STARTER)** | ✓ | ✓ |
|
||
| `/reassign @user1 @user2` | Change assignee **(STARTER)** | ✓ | ✓ |
|
||
| `/unassign` | Remove current assignee | ✓ | ✓ |
|
||
| `/milestone %milestone` | Set milestone | ✓ | ✓ |
|
||
| `/remove_milestone` | Remove milestone | ✓ | ✓ |
|
||
| `/label ~label1 ~label2` | Add label(s). Label names can also start without ~ but mixed syntax is not supported. | ✓ | ✓ |
|
||
| `/unlabel ~label1 ~label2` | Remove all or specific label(s)| ✓ | ✓ |
|
||
| `/relabel ~label1 ~label2` | Replace label | ✓ | ✓ |
|
||
| <code>/copy_metadata <#issue | !merge_request></code> | Copy labels and milestone from other issue or merge request in the project | ✓ | ✓ |
|
||
| <code>/estimate <1w 3d 2h 14m></code> | Set time estimate | ✓ | ✓ |
|
||
| `/remove_estimate` | Remove time estimate | ✓ | ✓ |
|
||
| <code>/spend <time(1h 30m | -1h 5m)> <date(YYYY-MM-DD)></code> | Add or subtract spent time; optionally, specify the date that time was spent on | ✓ | ✓ |
|
||
| `/remove_time_spent` | Remove time spent | ✓ | ✓ |
|
||
| `/lock` | Lock the discussion | ✓ | ✓ |
|
||
| `/unlock` | Unlock the discussion | ✓ | ✓ |
|
||
| <code>/due <in 2 days | this Friday | December 31st></code>| Set due date | ✓ | |
|
||
| `/remove_due_date` | Remove due date | ✓ | |
|
||
| <code>/weight <0 | 1 | 2 | ...></code> | Set weight **(STARTER)** | ✓ | |
|
||
| `/clear_weight` | Clears weight **(STARTER)** | ✓ | |
|
||
| <code>/epic <&epic | group&epic | Epic URL></code> | Add to epic **(ULTIMATE)** | ✓ | |
|
||
| `/remove_epic` | Removes from epic **(ULTIMATE)** | ✓ | |
|
||
| `/promote` | Promote issue to 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 | | ✓ |
|
||
| `/approve` | Approve the merge request | | ✓ |
|
||
| `/merge` | Merge (when pipeline succeeds) | | ✓ |
|
||
| `/create_merge_request <branch name>` | Create a new merge request starting from the current issue | ✓ | |
|
||
| `/relate #issue1 #issue2` | Mark issues as related **(STARTER)** | ✓ | |
|
||
|
||
## 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 To Do |
|
||
| `/done` | Mark To Do 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 |
|
||
| <code>/child_epic <&epic | group&epic | Epic URL></code> | Adds child epic to epic ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab-ee/issues/7330)) |
|
||
| <code>/remove_child_epic <&epic | group&epic | Epic URL></code> | Removes child epic from epic ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab-ee/issues/7330)) |
|
||
| <code>/parent_epic <&epic | group&epic | Epic URL></code> | Sets parent epic to epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-ee/issues/10556)) |
|
||
| <code>/remove_parent_epic | Removes parent epic from epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-ee/issues/10556)) |
|