realaravinth/debian-mirror-gitlab
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
debian-mirror-gitlab/doc/user/project/quick_actions.md

138 lines
18 KiB
Markdown
Raw Normal View History

New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
---
type: reference
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
stage: Plan
group: Project Management
New upstream version 13.7.7
2021-02-22 17:27:13 +05:30
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/#assignments
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
---
# GitLab Quick Actions
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
> - 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.
New upstream version 13.8.5+ds1
2021-03-08 18:12:59 +05:30
> - Introduced in [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/16877): you can use
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
> quick actions when updating the description of issues, epics, and merge requests.
New upstream version 13.8.5+ds1
2021-03-08 18:12:59 +05:30
> - Introduced in [GitLab 13.8](https://gitlab.com/gitlab-org/gitlab/-/issues/292393): when you enter
> `/` into a description or comment field, all available quick actions are displayed in a scrollable list.
> - The rebase quick action was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49800) in GitLab 13.8.
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
New upstream version 11.4.9+dfsg
2018-12-05 23:21:45 +05:30
Quick actions are textual shortcuts for common actions on issues, epics, merge requests,
New upstream version 13.7.7
2021-02-22 17:27:13 +05:30
and commits that are usually done by clicking buttons or dropdowns in the GitLab UI.
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
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.
New upstream version 12.3.8
2019-12-04 20:38:33 +05:30
## Quick Actions for issues, merge requests and epics
The following quick actions are applicable to descriptions, discussions and threads in:
- Issues
- Merge requests
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
- 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. |
New upstream version 13.9.3+ds1
2021-03-11 19:13:27 +05:30
| `/assign_reviewer @user` or `/reviewer @user` or `/request_review @user` | | ✓ | | Assign one user as a reviewer. |
| `/assign_reviewer @user1 @user2` or `/reviewer @user1 @user2` or `/request_review @user1 @user2` | | ✓ | | Assign multiple users as reviewers. **(STARTER)** |
| `/assign_reviewer me` or `/reviewer me` or `/request_review me` | | ✓ | | Assign yourself as a reviewer. |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/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)** |
New upstream version 13.7.7
2021-02-22 17:27:13 +05:30
| `/clone <path/to/project> [--with_notes]`| ✓ | | | Clone the issue to given project, or the current one if no arguments are given ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9421) in GitLab 13.7). Copies as much data as possible as long as the target project contains equivalent labels, milestones, and so on. Does not copy comments or system notes unless `--with_notes` is provided as an argument. |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/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. |
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
| `/done` | ✓ | ✓ | ✓ | Mark to do as done. |
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| `/draft` | | ✓ | | Toggle the draft status. |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/due <date>` | ✓ | | | Set due date. Examples of valid `<date>` include `in 2 days`, `this Friday` and `December 31st`. |
New upstream version 13.9.3+ds1
2021-03-11 19:13:27 +05:30
| `/duplicate <#issue>` | ✓ | | | Close this issue and mark as a duplicate of another issue. **(FREE)** Also, mark both as related. **(STARTER)** |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/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`. |
New upstream version 13.3.8
2020-10-24 23:57:45 +05:30
| `/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)** |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/label ~label1 ~label2` | ✓ | ✓ | ✓ | Add one or more labels. Label names can also start without a tilde (`~`), but mixed syntax is not supported. |
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
| `/lock` | ✓ | ✓ | | Lock the discussions. |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/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)** |
New upstream version 13.3.8
2020-10-24 23:57:45 +05:30
| `/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)** |
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
| `/reassign @user1 @user2` | ✓ | ✓ | | Replace current assignees with those specified. **(STARTER)** |
New upstream version 13.9.3+ds1
2021-03-11 19:13:27 +05:30
| `/rebase` | | ✓ | | Rebase source branch. This schedules a background task that attempts to rebase the changes in the source branch on the latest commit of the target branch. If `/rebase` is used, `/merge` is ignored to avoid a race condition where the source branch is merged or deleted before it is rebased. If there are merge conflicts, GitLab displays a message that a rebase cannot be scheduled. Rebase failures are displayed with the merge request status. |
New upstream version 13.8.5+ds1
2021-03-08 18:12:59 +05:30
| `/reassign_reviewer @user1 @user2` | | ✓ | | Replace current reviewers with those specified. **(STARTER)** |
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
| `/relabel ~label1 ~label2` | ✓ | ✓ | ✓ | Replace current labels with those specified. |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/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. |
New upstream version 13.3.8
2020-10-24 23:57:45 +05:30
| `/remove_iteration` | ✓ | | | Remove iteration ([introduced in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/196795)) **(STARTER)** |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/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. |
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| `/todo` | ✓ | ✓ | ✓ | Add a to-do item. |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/unassign @user1 @user2` | ✓ | ✓ | | Remove specific assignees. **(STARTER)** |
New upstream version 13.8.5+ds1
2021-03-08 18:12:59 +05:30
| `/unassign` | | ✓ | | Remove all assignees. |
New upstream version 13.9.3+ds1
2021-03-11 19:13:27 +05:30
| `/unassign_reviewer @user1 @user2` or `/remove_reviewer @user1 @user2` | | ✓ | | Remove specific reviewers. **(STARTER)** |
| `/unassign_reviewer` or `/remove_reviewer` | | ✓ | | Remove all reviewers. |
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
| `/unlabel ~label1 ~label2` or `/remove_label ~label1 ~label2` | ✓ | ✓ | ✓ | Remove specified labels. |
| `/unlabel` or `/remove_label` | ✓ | ✓ | ✓ | Remove all labels. |
| `/unlock` | ✓ | ✓ | | Unlock the discussions. |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/unsubscribe` | ✓ | ✓ | ✓ | Unsubscribe from notifications. |
| `/weight <value>` | ✓ | | | Set weight. Valid options for `<value>` include `0`, `1`, `2`, and so on. **(STARTER)** |
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| `/wip` | | ✓ | | Toggle the draft status. |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| `/zoom <Zoom URL>` | ✓ | | | Add Zoom meeting to this issue ([introduced in GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16609)). |
New upstream version 11.4.9+dfsg
2018-12-05 23:21:45 +05:30
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
## 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.
## 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
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
(`"`), unless it contains only these characters:
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
1. ASCII letters.
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
1. Numerals (0-9).
1. Underscore (`_`), hyphen (`-`), question mark (`?`), dot (`.`), or ampersand (`&`).
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
Parameters are also case-sensitive. Autocomplete handles this, and the insertion
of quotation marks, automatically.
New upstream version 11.4.9+dfsg
2018-12-05 23:21:45 +05:30
## Quick actions for commit messages
The following quick actions are applicable for commit messages:
| Command | Action |
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
| :---------------------- | :---------------------------------------- |
New upstream version 11.4.9+dfsg
2018-12-05 23:21:45 +05:30
| `/tag v1.2.3 <message>` | Tags this commit with an optional message |
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
<!-- ## 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. -->
Reference in a new issue Copy permalink