Skip to content

G
gitlab-ce
Commit 4412bcc0 authored by Suzanne Selhorn's avatar Suzanne Selhorn
Browse files
Options

Merge branch 'msj-quick-actions' into 'master' 

Sort quick actions list alphabetically

Closes #218456

See merge request gitlab-org/gitlab!32762
parents 6602aca6 b900fb9d
Hide whitespace changes
Inline Side-by-side
Showing with 63 additions and 62 deletions
doc/user/project/quick_actions.md
View file @ 4412bcc0
...@@ -10,7 +10,8 @@ You can enter these commands while creating a new issue or merge request, or ...@@ -10,7 +10,8 @@ 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 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. on a separate line in order to be properly detected and executed.
> From [GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/26672), once an action is executed, an alert is displayed when a quick action is successfully applied. > From [GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/26672), once an
> action is executed, an alert appears when a quick action is successfully applied.
## Quick Actions for issues, merge requests and epics ## Quick Actions for issues, merge requests and epics
...@@ -18,63 +19,63 @@ The following quick actions are applicable to descriptions, discussions and thre ...@@ -18,63 +19,63 @@ The following quick actions are applicable to descriptions, discussions and thre
- Issues - Issues
- Merge requests - Merge requests
- Epics **(ULTIMATE)** - Epics **(PREMIUM)**
| Command | Issue | Merge request | Epic | Action | | Command | Issue | Merge request | Epic | Action |
|:--------------------------------------|:------|:--------------|:-----|:------ | | :------------------------------------ | :---- | :------------ | :--- | :------------------------------------------------------------------------------------------------------------------------------ |
| `/tableflip <comment>` | ✓ | ✓ | ✓ | Append the comment with `(╯°□°)╯︵ ┻━┻` | | `/approve` | | ✓ | | Approve the merge request. **(STARTER)** |
| `/shrug <comment>` | ✓ | ✓ | ✓ | Append the comment with `¯\＿(ツ)＿/¯` | | `/assign @user` | ✓ | ✓ | | Assign one user. |
| `/todo` | ✓ | ✓ | ✓ | Add a To Do | | `/assign @user1 @user2` | ✓ | ✓ | | Assign multiple users. **(STARTER)** |
| `/done` | ✓ | ✓ | ✓ | Mark To Do as done | | `/assign me` | ✓ | ✓ | | Assign yourself. |
| `/subscribe` | ✓ | ✓ | ✓ | Subscribe | | `/award :emoji:` | ✓ | ✓ | ✓ | Toggle emoji award. |
| `/unsubscribe` | ✓ | ✓ | ✓ | Unsubscribe | | `/child_epic <epic>` | | | ✓ | Add child epic to `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab/-/issues/7330)). **(ULTIMATE)** |
| `/close` | ✓ | ✓ | ✓ | Close | | `/clear_weight` | ✓ | | | Clear weight. **(STARTER)** |
| `/reopen` | ✓ | ✓ | ✓ | Reopen | | `/close` | ✓ | ✓ | ✓ | Close. |
| `/title <new title>` | ✓ | ✓ | ✓ | Change title | | `/confidential` | ✓ | | | Make confidential. |
| `/award :emoji:` | ✓ | ✓ | ✓ | Toggle emoji award | | `/copy_metadata <!merge_request>` | ✓ | ✓ | | Copy labels and milestone from another merge request in the project. |
| `/assign me` | ✓ | ✓ | | Assign yourself | | `/copy_metadata <#issue>` | ✓ | ✓ | | Copy labels and milestone from another issue in the project. |
| `/assign @user` | ✓ | ✓ | | Assign one user | | `/create_merge_request <branch name>` | ✓ | | | Create a new merge request starting from the current issue. |
| `/assign @user1 @user2` | ✓ | ✓ | | Assign multiple users **(STARTER)** | | `/done` | ✓ | ✓ | ✓ | Mark To-Do as done. |
| `/reassign @user1 @user2` | ✓ | ✓ | | Change assignee **(STARTER)** | | `/due <date>` | ✓ | | | Set due date. Examples of valid `<date>` include `in 2 days`, `this Friday` and `December 31st`. |
| `/unassign` | ✓ | ✓ | | Remove current assignee | | `/duplicate <#issue>` | ✓ | | | Mark this issue as a duplicate of another issue and mark them as related. **(STARTER)** |
| `/unassign @user1 @user2` | ✓ | ✓ | | Remove assignee(s) **(STARTER)** | | `/epic <epic>` | ✓ | | | Add to epic `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic. **(PREMIUM)** |
| `/milestone %milestone` | ✓ | ✓ | | Set milestone | | `/estimate <<W>w <DD>d <hh>h <mm>m>` | ✓ | ✓ | | Set time estimate. For example, `/estimate 1w 3d 2h 14m`. |
| `/remove_milestone` | ✓ | ✓ | | Remove milestone | | `/label ~label1 ~label2` | ✓ | ✓ | ✓ | Add one or more labels. Label names can also start without a tilde (`~`), but mixed syntax is not supported. |
| `/label ~label1 ~label2` | ✓ | ✓ | ✓ | Add label(s). Label names can also start without `~` but mixed syntax is not supported | | `/lock` | ✓ | ✓ | | Lock the thread. |
| `/relabel ~label1 ~label2` | ✓ | ✓ | ✓ | Replace existing label(s) with those specified | | `/merge` | | ✓ | | Merge changes. Depending on the project setting, this may be [when the pipeline succeeds](merge_requests/merge_when_pipeline_succeeds.md), adding to a [Merge Train](../../ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md), etc. |
| `/unlabel ~label1 ~label2` or `/remove_label ~label1 ~label2` | ✓ | ✓ | ✓ | Remove all or specific label(s) | | `/milestone %milestone` | ✓ | ✓ | | Set milestone. |
| `/copy_metadata <#issue>` | ✓ | ✓ | | Copy labels and milestone from another issue in the project | | `/move <path/to/project>` | ✓ | | | Move this issue to another project. |
| `/copy_metadata <!merge_request>` | ✓ | ✓ | | Copy labels and milestone from another merge request in the project | | `/parent_epic <epic>` | | | ✓ | Set parent epic to `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab/-/issues/10556)). **(ULTIMATE)** |
| `/estimate <<W>w <DD>d <hh>h <mm>m>` | ✓ | ✓ | | Set time estimate. For example, `/estimate 1w 3d 2h 14m` | | `/promote` | ✓ | | | Promote issue to epic. **(PREMIUM)** |
| `/remove_estimate` | ✓ | ✓ | | Remove time estimate | | `/reassign @user1 @user2` | ✓ | ✓ | | Change assignee. **(STARTER)** |
| `/spend <time(<h>h <mm>m)> <date(<YYYY-MM-DD>)>` | ✓ | ✓ | | Add spent time; optionally specify the date that time was spent on. For example, `/spend time(1h 30m)` or `/spend time(1h 30m) date(2018-08-26)` | | `/relabel ~label1 ~label2` | ✓ | ✓ | ✓ | Replace existing labels with those specified. |
| `/spend <time(-<h>h <mm>m)> <date(<YYYY-MM-DD>)>` | ✓ | ✓ | | Subtract spent time; optionally specify the date that time was spent on. For example, `/spend time(-1h 30m)` or `/spend time(-1h 30m) date(2018-08-26)` | | `/relate #issue1 #issue2` | ✓ | | | Mark issues as related. **(STARTER)** |
| `/remove_time_spent` | ✓ | ✓ | | Remove time spent | | `/remove_child_epic <epic>` | | | ✓ | Remove child epic from `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab/-/issues/7330)). **(ULTIMATE)** |
| `/lock` | ✓ | ✓ | | Lock the thread | | `/remove_due_date` | ✓ | | | Remove due date. |
| `/unlock` | ✓ | ✓ | | Unlock the thread | | `/remove_epic` | ✓ | | | Remove from epic. **(PREMIUM)** |
| `/due <date>` | ✓ | | | Set due date. Examples of valid `<date>` include `in 2 days`, `this Friday` and `December 31st` | | `/remove_estimate` | ✓ | ✓ | | Remove time estimate. |
| `/remove_due_date` | ✓ | | | Remove due date | | `/remove_milestone` | ✓ | ✓ | | Remove milestone. |
| `/weight <value>` | ✓ | | | Set weight. Valid options for `<value>` include `0`, `1`, `2`, etc **(STARTER)** | | `/remove_parent_epic` | | | ✓ | Remove parent epic from epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab/-/issues/10556)). **(ULTIMATE)** |
| `/clear_weight` | ✓ | | | Clear weight **(STARTER)** | | `/remove_time_spent` | ✓ | ✓ | | Remove time spent. |
| `/epic <epic>` | ✓ | | | Add to epic `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic. **(ULTIMATE)** | | `/remove_zoom` | ✓ | | | Remove Zoom meeting from this issue ([introduced in GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609)). |
| `/remove_epic` | ✓ | | | Remove from epic **(ULTIMATE)** | | `/reopen` | ✓ | ✓ | ✓ | Reopen. |
| `/promote` | ✓ | | | Promote issue to epic **(ULTIMATE)** | | `/shrug <comment>` | ✓ | ✓ | ✓ | Append the comment with `¯\＿(ツ)＿/¯`. |
| `/confidential` | ✓ | | | Make confidential | | `/spend <time(-<h>h <mm>m)> <date(<YYYY-MM-DD>)>` | ✓ | ✓ | | Subtract spent time. Optionally, specify the date that time was spent on. For example, `/spend time(-1h 30m)` or `/spend time(-1h 30m) date(2018-08-26)`. |
| `/duplicate <#issue>` | ✓ | | | Mark this issue as a duplicate of another issue and relate them for **(STARTER)** | | `/spend <time(<h>h <mm>m)> <date(<YYYY-MM-DD>)>` | ✓ | ✓ | | Add spent time. Optionally, specify the date that time was spent on. For example, `/spend time(1h 30m)` or `/spend time(1h 30m) date(2018-08-26)`. |
| `/create_merge_request <branch name>` | ✓ | | | Create a new merge request starting from the current issue | | `/submit_review` | | ✓ | | Submit a pending review ([introduced in GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/issues/8041)). **(PREMIUM)** |
| `/relate #issue1 #issue2` | ✓ | | | Mark issues as related **(STARTER)** | | `/subscribe` | ✓ | ✓ | ✓ | Subscribe to notifications. |
| `/move <path/to/project>` | ✓ | | | Move this issue to another project | | `/tableflip <comment>` | ✓ | ✓ | ✓ | Append the comment with `(╯°□°)╯︵ ┻━┻`. |
| `/zoom <Zoom URL>` | ✓ | | | Add Zoom meeting to this issue. ([Introduced in GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609)) | | `/target_branch <local branch name>` | | ✓ | | Set target branch. |
| `/remove_zoom` | ✓ | | | Remove Zoom meeting from this issue. ([Introduced in GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609)) | | `/title <new title>` | ✓ | ✓ | ✓ | Change title. |
| `/target_branch <local branch name>` | | ✓ | | Set target branch | | `/todo` | ✓ | ✓ | ✓ | Add a To-Do. |
| `/wip` | | ✓ | | Toggle the Work In Progress status | | `/unassign @user1 @user2` | ✓ | ✓ | | Remove specific assignees. **(STARTER)** |
| `/approve` | | ✓ | | Approve the merge request **(STARTER)** | | `/unassign` | ✓ | ✓ | | Remove all assignees. |
| `/submit_review` | | ✓ | | Submit a pending review. ([Introduced in GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/issues/8041)) **(PREMIUM)** | | `/unlabel ~label1 ~label2` or `/remove_label ~label1 ~label2` | ✓ | ✓ | ✓ | Remove all or specific labels. |
| `/merge` | | ✓ | | Merge changes. Depending on the project setting, this may be [when the pipeline succeeds](merge_requests/merge_when_pipeline_succeeds.md), adding to a [Merge Train](../../ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md), etc). | | `/unlock` | ✓ | ✓ | | Unlock the thread. |
| `/child_epic <epic>` | | | ✓ | Add child epic to `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic. ([Introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab/-/issues/7330)) **(ULTIMATE)** | | `/unsubscribe` | ✓ | ✓ | ✓ | Unsubscribe from notifications. |
| `/remove_child_epic <epic>` | | | ✓ | Remove child epic from `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic. ([Introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab/-/issues/7330)) **(ULTIMATE)** | | `/weight <value>` | ✓ | | | Set weight. Valid options for `<value>` include `0`, `1`, `2`, and so on. **(STARTER)** |
| `/parent_epic <epic>` | | | ✓ | Set parent epic to `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic. ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab/-/issues/10556)) **(ULTIMATE)** | | `/wip` | | ✓ | | Toggle the Work In Progress status. |
| `/remove_parent_epic` | | | ✓ | Remove parent epic from epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab/-/issues/10556)) **(ULTIMATE)** | | `/zoom <Zoom URL>` | ✓ | | | Add Zoom meeting to this issue ([introduced in GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609)). |
## Autocomplete characters ## Autocomplete characters
...@@ -86,11 +87,11 @@ to enter a parameter, compared to selecting items from a list. ...@@ -86,11 +87,11 @@ to enter a parameter, compared to selecting items from a list.
The easiest way to set parameters for quick actions is to use autocomplete. If The easiest way to set parameters for quick actions is to use autocomplete. If
you manually enter a parameter, it must be enclosed in double quotation marks you manually enter a parameter, it must be enclosed in double quotation marks
(`"`), unless it contains only: (`"`), unless it contains only these characters:
1. ASCII letters. 1. ASCII letters.
1. Numerals. 1. Numerals (0-9).
1. Underscore, hyphen, question mark, dot, and ampersand. 1. Underscore (`_`), hyphen (`-`), question mark (`?`), dot (`.`), or ampersand (`&`).
Parameters are also case-sensitive. Autocomplete handles this, and the insertion Parameters are also case-sensitive. Autocomplete handles this, and the insertion
of quotation marks, automatically. of quotation marks, automatically.
...@@ -100,7 +101,7 @@ of quotation marks, automatically. ...@@ -100,7 +101,7 @@ of quotation marks, automatically.
The following quick actions are applicable for commit messages: The following quick actions are applicable for commit messages:
| Command | Action | | Command | Action |
|:------------------------|:------------------------------------------| | :---------------------- | :---------------------------------------- |
| `/tag v1.2.3 <message>` | Tags this commit with an optional message | | `/tag v1.2.3 <message>` | Tags this commit with an optional message |
<!-- ## Troubleshooting <!-- ## Troubleshooting
......
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