49 KiB
49 KiB
| type | stage | group | info |
|---|---|---|---|
| reference | Plan | Project Management | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments |
GitLab quick actions (FREE)
- Introduced in GitLab 12.1: once an action is executed, an alert appears when a quick action is successfully applied.
- Introduced in GitLab 13.2: you can use quick actions when updating the description of issues, epics, and merge requests.
- Introduced in GitLab 13.8: 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 in GitLab 13.8.
Quick actions are text-based shortcuts for common actions that are usually done by selecting buttons or dropdowns in the GitLab user interface. You can enter these commands in the descriptions or comments of issues, epics, merge requests, and commits.
Many quick actions are context-aware, requiring certain conditions be met. For example, to remove
an issue due date with /remove_due_date, the issue must have a due date set.
Be sure to enter each quick action on a separate line to allow GitLab to properly detect and execute the commands.
Parameters
Many quick actions require a parameter. For example, the /assign quick action
requires a username. GitLab uses autocomplete characters
with quick actions to help users enter parameters, by providing a list of
available values.
If you manually enter a parameter, it must be enclosed in double quotation marks
("), unless it contains only these characters:
- ASCII letters
- Numbers (0-9)
- Underscore (
_), hyphen (-), question mark (?), dot (.), ampersand (&) or at (@)
Parameters are case-sensitive. Autocomplete handles this, and the insertion of quotation marks, automatically.
Issues, merge requests, and epics
The following quick actions are applicable to descriptions, discussions, and threads. Some quick actions might not be available to all subscription tiers.
| Command | Issue | Merge request | Epic | Action |
|---|---|---|---|---|
/add_contacts [contact:email1@example.com] [contact:email2@example.com] |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Add one or more CRM contacts (introduced in GitLab 14.6). |
/approve |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Approve the merge request. |
/assign @user1 @user2 |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Assign one or more users. |
/assign me |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Assign yourself. |
/assign_reviewer @user1 @user2 or /reviewer @user1 @user2 or /request_review @user1 @user2 |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Assign one or more users as reviewers. |
/assign_reviewer me or /reviewer me or /request_review me |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Assign yourself as a reviewer. |
/award :emoji: |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Toggle emoji award. |
/cc @user |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Mention a user. In GitLab 15.0 and later, this command performs no action. You can instead type CC @user or only @user. In GitLab 14.9 and earlier, mentioning a user at the start of a line created a specific type of to-do item notification. |
/child_epic <epic> |
{dotted-circle} No | {dotted-circle} No | {check-circle} Yes | 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). |
/clear_health_status |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Clear health status (introduced in GitLab 14.7). |
/clear_weight |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Clear weight. |
/clone <path/to/project> [--with_notes] |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Clone the issue to given project, or the current one if no arguments are given (introduced 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. |
/close |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Close. |
/confidential |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Make confidential. |
/copy_metadata <!merge_request> |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Copy labels and milestone from another merge request in the project. |
/copy_metadata <#issue> |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Copy labels and milestone from another issue in the project. |
/create_merge_request <branch name> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Create a new merge request starting from the current issue. |
/done |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Mark to do as done. |
/draft |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Set the draft status. Use for toggling the draft status (deprecated in GitLab 15.4.) |
/due <date> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Set due date. Examples of valid <date> include in 2 days, this Friday and December 31st. |
/duplicate <#issue> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Close this issue and mark as a duplicate of another issue. Also, mark both as related. |
/epic <epic> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Add to epic <epic>. The <epic> value should be in the format of &epic, group&epic, or a URL to an epic. |
/estimate <time> |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Set time estimate. For example, /estimate 1mo 2w 3d 4h 5m. Learn more about time tracking. |
/health_status <value> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Set health status. Valid options for <value> are on_track, needs_attention, and at_risk (introduced in GitLab 14.7). |
/invite_email email1 email2 |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Add up to six email participants. This action is behind feature flag issue_email_participants and is not yet supported in issue templates. |
/iteration *iteration:"iteration name" |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Set iteration. For example, to set the Late in July iteration: /iteration *iteration:"Late in July" (introduced in GitLab 13.1). |
/label ~label1 ~label2 |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Add one or more labels. Label names can also start without a tilde (~), but mixed syntax is not supported. |
/lock |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Lock the discussions. |
/link |
{check-circle} Yes | **{dotted-circle} No | {dotted-circle} No | Add a link and description to linked resources in an incident (introduced in GitLab 15.5). |
/merge |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Merge changes. Depending on the project setting, this may be when the pipeline succeeds, or adding to a Merge Train. |
/milestone %milestone |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Set milestone. |
/move <path/to/project> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Move this issue to another project. Be careful when moving an issue to a project with different access rules. Before moving the issue, make sure it does not contain sensitive data. |
/parent_epic <epic> |
{dotted-circle} No | {dotted-circle} No | {check-circle} Yes | 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). |
/promote |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Promote issue to epic. |
/promote_to_incident |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Promote issue to incident (introduced in GitLab 14.5). |
/page <policy name> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Start escalations for the incident (introduced in GitLab 14.9). |
/publish |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Publish issue to an associated Status Page (Introduced in GitLab 13.0) |
/ready |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Set the ready status (Introduced in GitLab 15.1). |
/reassign @user1 @user2 |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Replace current assignees with those specified. |
/reassign_reviewer @user1 @user2 |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Replace current reviewers with those specified. |
/rebase |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | 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. |
/relabel ~label1 ~label2 |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Replace current labels with those specified. |
/relate #issue1 #issue2 |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Mark issues as related. |
/remove_child_epic <epic> |
{dotted-circle} No | {dotted-circle} No | {check-circle} Yes | 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). |
/remove_contacts [contact:email1@example.com] [contact:email2@example.com] |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Remove one or more CRM contacts (introduced in GitLab 14.6). |
/remove_due_date |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Remove due date. |
/remove_epic |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Remove from epic. |
/remove_estimate |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Remove time estimate. |
/remove_iteration |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Remove iteration (introduced in GitLab 13.1). |
/remove_milestone |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Remove milestone. |
/remove_parent_epic |
{dotted-circle} No | {dotted-circle} No | {check-circle} Yes | Remove parent epic from epic (introduced in GitLab 12.1). |
/remove_time_spent |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Remove time spent. |
/remove_zoom |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Remove Zoom meeting from this issue. |
/reopen |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Reopen. |
/severity <severity> |
{check-circle} Yes | {check-circle} No | {check-circle} No | Set the severity. Issue type must be Incident. Options for <severity> are S1 ... S4, critical, high, medium, low, unknown. Introduced in GitLab 14.2. |
/shrug <comment> |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Append the comment with ¯\＿(ツ)＿/¯. |
/spend <time> [<date>] |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Add or subtract spent time. Optionally, specify the date that time was spent on. For example, /spend 1mo 2w 3d 4h 5m 2018-08-26 or /spend -1h 30m. Learn more about time tracking. |
/submit_review |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Submit a pending review (introduced in GitLab 12.7). |
/subscribe |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Subscribe to notifications. |
/tableflip <comment> |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Append the comment with (╯°□°)╯︵ ┻━┻. |
/target_branch <local branch name> |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Set target branch. |
/title <new title> |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Change title. |
/timeline <timeline comment> | <date(YYYY-MM-DD)> <time(HH:MM)> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Add a timeline event to this incident. For example, /timeline DB load spiked | 2022-09-07 09:30. (introduced in GitLab 15.4). |
/todo |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Add a to-do item. |
/unapprove |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Unapprove the merge request. (introduced in GitLab 14.3 |
/unassign @user1 @user2 |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Remove specific assignees. |
/unassign |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Remove all assignees. |
/unassign_reviewer @user1 @user2 or /remove_reviewer @user1 @user2 |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Remove specific reviewers. |
/unassign_reviewer me |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Remove yourself as a reviewer. |
/unassign_reviewer or /remove_reviewer |
{dotted-circle} No | {check-circle} Yes | {dotted-circle} No | Remove all reviewers. |
/unlabel ~label1 ~label2 or /remove_label ~label1 ~label2 |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Remove specified labels. |
/unlabel or /remove_label |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Remove all labels. |
/unlock |
{check-circle} Yes | {check-circle} Yes | {dotted-circle} No | Unlock the discussions. |
/unsubscribe |
{check-circle} Yes | {check-circle} Yes | {check-circle} Yes | Unsubscribe from notifications. |
/weight <value> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Set weight. Valid options for <value> include 0, 1, 2, and so on. |
/zoom <Zoom URL> |
{check-circle} Yes | {dotted-circle} No | {dotted-circle} No | Add a Zoom meeting to this issue or incident. In GitLab 15.3 and later users on GitLab Premium can add a short description when adding a Zoom link to an incident. |
Commit messages
The following quick actions are applicable for commit messages:
| Command | Action |
|---|---|
/tag v1.2.3 <message> |
Tags the commit with an optional message. |