92 lines
7.2 KiB
Markdown
92 lines
7.2 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 existing label(s) with those specified | ✓ | ✓ |
|
||
| `/copy_metadata <#issue | !merge_request>` | Copy labels and milestone from other issue or merge request in the project | ✓ | ✓ |
|
||
| `/estimate <1w 3d 2h 14m>` | Set time estimate | ✓ | ✓ |
|
||
| `/remove_estimate` | Remove time estimate | ✓ | ✓ |
|
||
| `/spend <time(1h 30m | -1h 5m)> <date(YYYY-MM-DD)>` | Add or subtract spent time; optionally, specify the date that time was spent on | ✓ | ✓ |
|
||
| `/remove_time_spent` | Remove time spent | ✓ | ✓ |
|
||
| `/lock` | Lock the thread | ✓ | ✓ |
|
||
| `/unlock` | Unlock the thread | ✓ | ✓ |
|
||
| `/due <in 2 days | this Friday | December 31st>`| Set due date | ✓ | |
|
||
| `/remove_due_date` | Remove due date | ✓ | |
|
||
| `/weight <0 | 1 | 2 | ...>` | Set weight **(STARTER)** | ✓ | |
|
||
| `/clear_weight` | Clears weight **(STARTER)** | ✓ | |
|
||
| `/epic <&epic | group&epic | Epic URL>` | 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 existing label(s) with those specified |
|
||
| `/child_epic <&epic | group&epic | Epic URL>` | Adds child epic to epic ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab-ee/issues/7330)) |
|
||
| `/remove_child_epic <&epic | group&epic | Epic URL>` | Removes child epic from epic ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab-ee/issues/7330)) |
|
||
| `/parent_epic <&epic | group&epic | Epic URL>` | Sets parent epic to epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-ee/issues/10556)) |
|
||
| `/remove_parent_epic` | Removes parent epic from epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-ee/issues/10556)) |
|