quick_actions.md 15,2 КБ
Newer Older
Marcia Ramos's avatar
Marcia Ramos включено в состав коммита
1
2
---
type: reference
GitLab Bot's avatar
GitLab Bot включено в состав коммита
3
4
5
stage: Plan
group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
Marcia Ramos's avatar
Marcia Ramos включено в состав коммита
6
7
8
---

# GitLab Quick Actions
Eric Eastwood's avatar
Eric Eastwood включено в состав коммита
9

GitLab Bot's avatar
GitLab Bot включено в состав коммита
10
11
12
13
14
> - Introduced in [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.
> - In [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/16877) and later, you can use
>   quick actions when updating the description of issues, epics, and merge requests.

Jarka Košanová's avatar
Jarka Košanová включено в состав коммита
15
Quick actions are textual shortcuts for common actions on issues, epics, merge requests,
Victor Wu's avatar
Victor Wu включено в состав коммита
16
and commits that are usually done by clicking buttons or dropdowns in GitLab's UI.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
17
18
You can enter these commands in the description 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.
Victor Wu's avatar
Victor Wu включено в состав коммита
19

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
20
21
## Quick Actions for issues, merge requests and epics

Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
22
23
24
25
The following quick actions are applicable to descriptions, discussions and threads in:

- Issues
- Merge requests
GitLab Bot's avatar
GitLab Bot включено в состав коммита
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
- Epics **(PREMIUM)**

| Command                               | Issue | Merge request | Epic | Action                                                                                                                          |
| :------------------------------------ | :---- | :------------ | :--- | :------------------------------------------------------------------------------------------------------------------------------ |
| `/approve`                            |       | ✓             |      | Approve the merge request. **(STARTER)**                                                                                         |
| `/assign @user`                       | ✓     | ✓             |      | Assign one user.                                                                                                                 |
| `/assign @user1 @user2`               | ✓     | ✓             |      | Assign multiple users. **(STARTER)**                                                                                             |
| `/assign me`                          | ✓     | ✓             |      | Assign yourself.                                                                                                                 |
| `/award :emoji:`                      | ✓     | ✓             | ✓    | Toggle emoji award.                                                                                                              |
| `/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)** |
| `/clear_weight`                       | ✓     |               |      | Clear weight. **(STARTER)**                                                                                                      |
| `/close`                              | ✓     | ✓             | ✓    | Close.                                                                                                                           |
| `/confidential`                       | ✓     |               |      | Make confidential.                                                                                                               |
| `/copy_metadata <!merge_request>`     | ✓     | ✓             |      | Copy labels and milestone from another merge request in the project.                                                             |
| `/copy_metadata <#issue>`             | ✓     | ✓             |      | Copy labels and milestone from another issue in the project.                                                                     |
| `/create_merge_request <branch name>` | ✓     |               |      | Create a new merge request starting from the current issue.                                                                      |
| `/done`                               | ✓     | ✓             | ✓    | Mark To-Do as done.                                                                                                              |
| `/due <date>`                         | ✓     |               |      | Set due date. Examples of valid `<date>` include `in 2 days`, `this Friday` and `December 31st`.                                 |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
44
| `/duplicate <#issue>`                 | ✓     |               |      | Close this issue and mark as a duplicate of another issue. **(CORE)** Also, mark both as related. **(STARTER)**                                          |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
45
46
| `/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)**  |
| `/estimate <<W>w <DD>d <hh>h <mm>m>`  | ✓     | ✓             |      | Set time estimate. For example, `/estimate 1w 3d 2h 14m`.                                                                        |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
47
| `/iteration *iteration:"iteration name"`     | ✓     |               |      | Set iteration. For example, to set the `Late in July` iteration: `/iteration *iteration:"Late in July"` ([introduced in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/196795)). **(STARTER)** |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
48
49
50
51
52
53
54
| `/label ~label1 ~label2`              | ✓     | ✓             | ✓    | Add one or more labels. Label names can also start without a tilde (`~`), but mixed syntax is not supported.                      |
| `/lock`                               | ✓     | ✓             |      | Lock the thread.                                                                                                                 |
| `/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.  |
| `/milestone %milestone`               | ✓     | ✓             |      | Set milestone.                                                                                                                   |
| `/move <path/to/project>`             | ✓     |               |      | Move this issue to another 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)** |
| `/promote`                            | ✓     |               |      | Promote issue to epic. **(PREMIUM)**                                                                                            |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
55
| `/publish`                            | ✓     |               |      | Publish issue to an associated [Status Page](../../operations/incident_management/status_page.md) ([Introduced in GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30906)) **(ULTIMATE)** |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
56
57
58
59
60
61
62
| `/reassign @user1 @user2`             | ✓     | ✓             |      | Change assignee. **(STARTER)**                                                                                                   |
| `/relabel ~label1 ~label2`            | ✓     | ✓             | ✓    | Replace existing labels with those specified.                                                                                  |
| `/relate #issue1 #issue2`             | ✓     |               |      | Mark issues as related. **(STARTER)**                                                                                            |
| `/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)** |
| `/remove_due_date`                    | ✓     |               |      | Remove due date.                                                                                                                 |
| `/remove_epic`                        | ✓     |               |      | Remove from epic. **(PREMIUM)**                                                                                                  |
| `/remove_estimate`                    | ✓     | ✓             |      | Remove time estimate.                                                                                                            |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
63
| `/remove_iteration`                   | ✓     |               |      | Remove iteration ([introduced in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/196795)) **(STARTER)** |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
| `/remove_milestone`                   | ✓     | ✓             |      | Remove milestone.                                                                                                                |
| `/remove_parent_epic`                 |       |               | ✓    | Remove parent epic from epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab/-/issues/10556)). **(ULTIMATE)**    |
| `/remove_time_spent`                  | ✓     | ✓             |      | Remove time spent.                                                                                                               |
| `/remove_zoom`                        | ✓     |               |      | Remove Zoom meeting from this issue ([introduced in GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609)). |
| `/reopen`                             | ✓     | ✓             | ✓    | Reopen.                                                                                                                          |
| `/shrug <comment>`                    | ✓     | ✓             | ✓    | Append the comment with `¯\_(ツ)_/¯`.                                                                                          |
| `/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)`. |
| `/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)`. |
| `/submit_review`                      |       | ✓             |      | Submit a pending review ([introduced in GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/issues/8041)). **(PREMIUM)**          |
| `/subscribe`                          | ✓     | ✓             | ✓    | Subscribe to notifications.                                                                                                    |
| `/tableflip <comment>`                | ✓     | ✓             | ✓    | Append the comment with `(╯°□°)╯︵ ┻━┻`.                                                                                        |
| `/target_branch <local branch name>`  |       | ✓             |      | Set target branch.                                                                                                              |
| `/title <new title>`                  | ✓     | ✓             | ✓    | Change title.                                                                                                                  |
| `/todo`                               | ✓     | ✓             | ✓    | Add a To-Do.                                                                                                                   |
| `/unassign @user1 @user2`             | ✓     | ✓             |      | Remove specific assignees. **(STARTER)**                                                                                       |
| `/unassign`                           | ✓     | ✓             |      | Remove all assignees.                                                                                                          |
| `/unlabel ~label1 ~label2` or `/remove_label ~label1 ~label2` | ✓     | ✓             | ✓    | Remove all or specific labels.                                                                          |
| `/unlock`                             | ✓     | ✓             |      | Unlock the thread.                                                                                                              |
| `/unsubscribe`                        | ✓     | ✓             | ✓    | Unsubscribe from notifications.                                                                                                |
| `/weight <value>`                     | ✓     |               |      | Set weight. Valid options for `<value>` include `0`, `1`, `2`, and so on. **(STARTER)**                                         |
| `/wip`                                |       | ✓             |      | Toggle the Work In Progress status.                                                                                              |
| `/zoom <Zoom URL>`                    | ✓     |               |      | Add Zoom meeting to this issue ([introduced in GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609)).      |
Victor Wu's avatar
Victor Wu включено в состав коммита
86

Russell Dickenson's avatar
Russell Dickenson включено в состав коммита
87
88
89
90
91
92
## Autocomplete characters

Many quick actions require a parameter, for example: username, milestone, and
label. [Autocomplete characters](autocomplete_characters.md) can make it easier
to enter a parameter, compared to selecting items from a list.

Sean McGivern's avatar
Sean McGivern включено в состав коммита
93
94
95
96
## Quick actions parameters

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
GitLab Bot's avatar
GitLab Bot включено в состав коммита
97
(`"`), unless it contains only these characters:
Sean McGivern's avatar
Sean McGivern включено в состав коммита
98
99

1. ASCII letters.
GitLab Bot's avatar
GitLab Bot включено в состав коммита
100
101
1. Numerals (0-9).
1. Underscore (`_`), hyphen (`-`), question mark (`?`), dot (`.`), or ampersand (`&`).
Sean McGivern's avatar
Sean McGivern включено в состав коммита
102
103
104
105

Parameters are also case-sensitive. Autocomplete handles this, and the insertion
of quotation marks, automatically.

Victor Wu's avatar
Victor Wu включено в состав коммита
106
107
108
109
110
## Quick actions for commit messages

The following quick actions are applicable for commit messages:

| Command                 | Action                                    |
GitLab Bot's avatar
GitLab Bot включено в состав коммита
111
| :---------------------- | :---------------------------------------- |
Victor Wu's avatar
Victor Wu включено в состав коммита
112
113
| `/tag v1.2.3 <message>` | Tags this commit with an optional message |

Marcia Ramos's avatar
Marcia Ramos включено в состав коммита
114
115
116
117
118
119
120
121
122
123
124
<!-- ## Troubleshooting

Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.

Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->