极狐GitLab 快捷操作
- Tier: 基础版, 专业版, 旗舰版
- Offering: JihuLab.com, 私有化部署
快速操作为极狐GitLab 中的常见操作提供了基于文本的快捷方式。快速操作:
- 无需使用用户界面即可执行常见操作。
- 支持与议题、合并请求、史诗和提交一起工作。
- 保存描述或评论时自动运行。
- 响应特定的上下文和条件。
- 在单独的行中输入时处理多个命令。
例如,你可以使用快速操作来:
- 分配用户。
- 添加标签。
- 设置截止日期。
- 更改状态。
- 设置其他属性。
每个命令都以正斜杠(/)开头,必须单独输入在一行上。许多快速操作接受参数,你可以使用引号(")或特定格式输入参数。
参数
许多快速操作需要一个参数。例如,/assign 快速操作需要用户名。极狐GitLab 使用自动完成字符来帮助用户输入参数,提供可用值的列表。
如果你手动输入参数,必须用双引号(")括起来,除非它仅包含以下字符:
- ASCII 字母
- 数字(0-9)
- 下划线(_)、连字符(-)、问号(?)、点(.)、和号(&)或 at 符号(@)
参数区分大小写。自动完成会自动处理这一点以及引号的插入。
议题、合并请求和史诗
以下快速操作适用于描述、讨论和线程。某些快速操作可能不适用于所有订阅级别。
命令 | 议题 | 合并请求 | 史诗 | 操作 |
---|---|---|---|---|
/add_child <item> | 是 | 否 | 是 | 添加 <item> 作为子项。<item> 值应为 #item、group/project#item 或指向该项的 URL。对于议题,你可以添加任务和 OKRs。必须启用议题的新外观。对于史诗,你可以添加议题、任务和 OKRs。多个工作项可以同时添加为子项。必须启用史诗的新外观。 |
/add_contacts [contact:email1@example.com] [contact:email2@example.com] | 是 | 否 | 否 | 添加一个或多个活动的 CRM 联系人。 |
/add_email email1 email2 | 是 | 否 | 否 | 添加最多六个 电子邮件参与者。此操作在功能标志 issue_email_participants 后面。不支持在议题模板中使用。 |
/approve | 否 | 是 | 否 | 批准合并请求。 |
/assign @user1 @user2 | 是 | 是 | 否 | 分配一个或多个用户。 |
/assign me | 是 | 是 | 否 | 分配给自己。 |
/assign_reviewer @user1 @user2 or /reviewer @user1 @user2 | 否 | 是 | 否 | 分配一个或多个用户作为审阅者。 |
/assign_reviewer me or /reviewer me | 否 | 是 | 否 | 分配自己作为审阅者。 |
/blocked_by <item1> <item2> | 是 | 否 | 是 | 将项目标记为被其他项目阻塞。<item> 值应为 #item、group/project#item 或完整的 URL。(在极狐GitLab 16.0 中引入)。对于史诗,必须启用史诗的新外观。 |
/blocks <item1> <item2> | 是 | 否 | 是 | 将项目标记为阻塞其他项目。<item> 值应为 #item、group/project#item 或完整的 URL。(在极狐GitLab 16.0 中引入)。对于史诗,必须启用史诗的新外观。 |
/board_move ~column | 是 | 否 | 否 | 将议题移动到看板上的列。项目必须只有一个议题看板。 |
/cc @user | 是 | 是 | 是 | 提及一个用户。此命令不执行任何操作。你可以改为输入 CC @user 或仅 @user。 |
/clear_health_status | 是 | 否 | 是 | 清除健康状态。对于史诗,必须启用史诗的新外观。 |
/clear_weight | 是 | 否 | 否 | 清除权重。 |
/clone <path/to/project> [--with_否tes] | 是 | 否 | 否 | 克隆议题到指定项目,如果没有提供参数则克隆到当前项目。只要目标项目包含等效对象(如标签、里程碑或史诗),就尽可能多地复制数据。除非提供 --with_否tes 参数,否则不复制评论或系统备注。 |
/close | 是 | 是 | 是 | 关闭。 |
/confidential | 是 | 否 | 是 | 将议题或史诗标记为机密。在极狐GitLab 15.6 中引入对史诗的支持。 |
/convert_to_ticket <email address> | 是 | 否 | 否 | 将议题转换为服务台工单。在极狐GitLab 16.9 中引入。 |
/copy_metadata <!merge_request> | 是 | 是 | 否 | 从项目中的另一个合并请求复制标签和里程碑。 |
/copy_metadata <#item> | 是 | 是 | 是 | 从项目中的另一个议题复制标签和里程碑。对于史诗,必须启用史诗的新外观。 |
/create_merge_request <branch name> | 是 | 否 | 否 | 从当前议题创建一个新的合并请求。 |
/done | 是 | 是 | 是 | 将待办事项标记为已完成。 |
/draft | 否 | 是 | 否 | 设置草稿状态。 |
/due <date> | 是 | 否 | 是 | 设置截止日期。有效的 <date> 示例包括 in 2 days、this Friday 和 December 31st。对于史诗,必须启用史诗的新外观。 |
/duplicate <item> | 是 | 否 | 是 | 关闭此 |
/epic <epic> or /set_parent <epic> | 是 | 否 | 是 | 添加到史诗 <epic> 作为子项。<epic> 值应为 &epic、group&epic 或指向一个史诗的 URL。对于史诗,必须启用史诗的新外观。别名 /set_parent 在极狐GitLab 17.10 中引入。 |
/estimate <time> or /estimate_time <time> | 是 | 是 | 是 | 设置时间估算。例如,/estimate 1mo 2w 3d 4h 5m。有关更多信息,请参见时间跟踪。别名 /estimate_time 在极狐GitLab 15.6 中引入。对于史诗,必须启用史诗的新外观。 |
/health_status <value> | 是 | 否 | 是 | 设置健康状态。对于史诗,必须启用史诗的新外观。<value> 的有效选项是 on_track、needs_attention 和 at_risk。 |
/iteration *iteration:<iteration ID> or <iteration name> | 是 | 否 | 否 | 设置迭代。例如,要设置 Late in July 迭代:/iteration *iteration:"Late in July"。 |
/iteration [cadence:<iteration cadence ID> or <iteration cadence name>] <--current or --next> | 是 | 否 | 否 | 将迭代设置为引用的迭代节奏的当前或下一个即将到来的迭代。例如,/iteration [cadence:"Team cadence"] --current 将迭代设置为名为 "Team cadence" 的迭代节奏的当前迭代。在极狐GitLab 16.9 中引入。 |
/iteration <--current or --next> | 是 | 否 | 否 | 当群组只有一个迭代节奏时,将迭代设置为当前或下一个即将到来的迭代。例如,/iteration --current 将迭代设置为迭代节奏的当前迭代。在极狐GitLab 16.9 中引入。 |
/label ~label1 ~label2 or /labels ~label1 ~label2 | 是 | 是 | 是 | 添加一个或多个标签。标签名称也可以不以波浪号(~)开头,但不支持混合语法。 |
/link | 是 | 否 | 否 | 添加链接和描述到事故中的链接资源 (在极狐GitLab 15.5 中引入)。 |
/lock | 是 | 是 | 是 | 锁定讨论。对于史诗,必须启用史诗的新外观。 |
/merge | 否 | 是 | 否 | 合并更改。根据项目设置,这可能是当流水线成功时,或添加到合并列车。 |
/milestone %milestone | 是 | 是 | 否 | 设置里程碑。 |
/move <path/to/project> | 是 | 否 | 否 | 将此议题移动到另一个项目。在将议题移动到具有不同访问规则的项目时要小心。移动议题之前,请确保它不包含敏感数据。 |
/page <policy name> | 是 | 否 | 否 | 开始事故的升级。 |
/parent_epic <epic> | 否 | 否 | 是 | 将父史诗设置为 <epic>。<epic> 值应为 &epic、group&epic 或指向一个史诗的 URL。如果启用了史诗的新外观,请改用 /set_parent。 |
/promote_to_incident | 是 | 否 | 否 | 将议题提升为事故。在极狐GitLab 15.8 及更高版本中,你还可以在创建新议题时使用快速操作。 |
/promote | 是 | 否 | 否 | 将议题提升为史诗。如果启用了议题的新外观,请改用 /promote_to epic。 |
/publish | 是 | 否 | 否 | 发布议题到相关的状态页面。 |
/react :emoji: | 是 | 是 | 是 | 切换表情符号反应。在极狐GitLab 16.7 中重命名自 /award。/award 仍然可用作为别名命令。 |
/ready | 否 | 是 | 否 | 设置准备状态 (在极狐GitLab 15.1 中引入)。 |
/reassign @user1 @user2 | 是 | 是 | 否 | 用指定的人员替换当前的受托人。 |
/reassign_reviewer @user1 @user2 | 否 | 是 | 否 | 用指定的人员替换当前的审阅者。 |
/rebase | 否 | 是 | 否 | 将源分支变基到目标分支的最新提交。有关帮助,请参见故障排除信息。 |
/relabel ~label1 ~label2 | 是 | 是 | 是 | 用指定的标签替换当前标签。 |
/relate <item1> <item2> | 是 | 否 | 是 | 将项目标记为相关。<item> 值应为 #item、group/project#item 或完整的 URL。对于史诗,必须启用史诗的新外观。 |
/remove_child <item> | 是 | 否 | 是 | 移除 <item> 作为子项。<item> 值应为 #item、group/project#item 或指向该项的 URL。对于议题,必须启用议题的新外观。对于史诗,必须启用史诗的新外观。 |
/remove_child_epic <epic> | 否 | 否 | 是 | 从 <epic> 中移除子史诗。<epic> 值应为 &epic、group&epic 或指向一个史诗的 URL。如果启用了史诗的新外观,请改用 /remove_child。 |
/remove_contacts [contact:email1@example.com] [contact:email2@example.com] | 是 | 否 | 否 | 移除一个或多个 CRM 联系人 |
/remove_due_date | 是 | 否 | 否 | 移除截止日期。 |
/remove_email email1 email2 | 是 | 否 | 否 | 移除最多六个 电子邮件参与者。此操作在功能标志 issue_email_participants 后面。不支持在议题模板、合并请求或史诗中使用。 |
/remove_epic | 是 | 否 | 否 | 将史诗移除为父项。如果启用了史诗的新外观,请改用 /remove_parent。 |
/remove_estimate or /remove_time_estimate | 是 | 是 | 是 | 移除时间估算。别名 /remove_time_estimate 在极狐GitLab 15.6 中引入。对于史诗,必须启用史诗的新外观。 |
/remove_iteration | 是 | 否 | 否 | 移除迭代。 |
/remove_milestone | 是 | 是 | 否 | 移除里程碑。 |
/remove_parent | 是 | 否 | 是 | 从项目中移除父项。对于议题,必须启用议题的新外观。对于史诗,必须启用史诗的新外观。 |
/remove_parent_epic | 否 | 否 | 是 | 从史诗中移除父史诗。如果启用了史诗的新外观,请改用 /remove_parent。 |
/remove_time_spent | 是 | 是 | 是 | 移除已花费的时间。对于史诗,必须启用史诗的新外观。 |
/remove_zoom | 是 | 否 | 否 | 从此议题中移除 Zoom 会议。 |
/reopen | 是 | 是 | 是 | 重新打开。 |
/request_review @user1 @user2 | 否 | 是 | 否 | 分配或请求一个或多个用户的新审阅。 |
/request_review me | 否 | 是 | 否 | 分配或请求一个或多个用户的新审阅。 |
/set_parent <item> | 是 | 否 | 是 | 设置父项。<item> 值应为 #IID、引用或指向项目的 URL。对于议题,必须启用议题的新外观。对于史诗,必须启用史诗的新外观。 |
/severity <severity> | 是 | 否 | 否 | 设置严重性。议题类型必须是 Incident。<severity> 的选项包括 S1 ... S4、critical、high、medium、low、unk否wn。 |
/shrug | 是 | 是 | 是 | 添加 ¯\_(ツ)_/¯。 |
/spend <time> [<date>] or /spend_time <time> [<date>] | 是 | 是 | 是 | 添加或减去已用时间。可选地,指定时间花费的日期。例如,/spend 1mo 2w 3d 4h 5m 2018-08-26 或 /spend -1h 30m。有关更多信息,请参见时间跟踪。别名 /spend_time 在极狐GitLab 15.6 中引入。对于史诗,必须启用史诗的新外观。 |
/submit_review | 否 | 是 | 否 | 提交待处理的审阅。 |
/subscribe | 是 | 是 | 是 | 订阅通知。 |
/tableflip | 是 | 是 | 是 | 添加 (╯°□°)╯︵ ┻━┻。 |
/target_branch <local branch name> | 否 | 是 | 否 | 设置目标分支。 |
/timeline <timeline comment> | <date(YYYY-MM-DD)> <time(HH:MM)> | 是 | 否 | 否 | 向此事故添加时间轴事件。例如,/timeline DB load spiked | 2022-09-07 09:30。(在极狐GitLab 15.4 中引入)。 |
/title <new title> | 是 | 是 | 是 | 更改标题。 |
/todo | 是 | 是 | 是 | 添加待办事项。 |
/unapprove | 否 | 是 | 否 | 撤销批准合并请求。 |
/unassign @user1 @user2 | 是 | 是 | 否 | 移除指定的受托人。 |
/unassign_reviewer @user1 @user2 or /remove_reviewer @user1 @user2 | 否 | 是 | 否 | 移除指定的审阅者。 |
/unassign_reviewer me | 否 | 是 | 否 | 移除自己作为审阅者。 |
/unassign_reviewer or /remove_reviewer | 否 | 是 | 否 | 移除所有审阅者。 |
/unassign | 否 | 是 | 否 | 移除所有受托人。 |
/unlabel ~label1 ~label2 or /remove_label ~label1 ~label2 | 是 | 是 | 是 | 移除指定的标签。 |
/unlabel or /remove_label | 是 | 是 | 是 | 移除所有标签。 |
/unlink <item> | 是 | 否 | 是 | 移除与提供的议题的链接。<item> 值应为 #item、group/project#item 或完整的 URL。(在极狐GitLab 16.1 中引入)。对于史诗,必须启用史诗的新外观。 |
/unlock | 是 | 是 | 是 | 解锁讨论。对于史诗,必须启用史诗的新外观。 |
/unsubscribe | 是 | 是 | 是 | 取消订阅通知。 |
/weight <value> | 是 | 否 | 否 | 设置权重。有效值为整数,如 0、1 或 2。 |
/zoom <Zoom URL> | 是 | 否 | 否 | 向此议题或事故添加 Zoom 会议。在极狐GitLab 15.3 及更高版本中,极狐GitLab 专业版用户可以在向事故添加 Zoom 链接时添加简短描述。 |
工作项
History
- 从评论中执行快速操作在极狐GitLab 15.10 中引入。
极狐GitLab 中的工作项包括任务和 OKRs。在编辑或评论工作项时,可以通过描述字段应用以下快速操作。
命令 | 任务 | 目标 | 关键结果 | 操作 |
---|---|---|---|---|
/assign @user1 @user2 | 是 | 是 | 是 | 分配一个或多个用户。 |
/assign me | 是 | 是 | 是 | 分配给自己。 |
/add_child <work_item> | 否 | 是 | 否 | 向 <work_item> 添加子项。<work_item> 值应为 #item、group/project#item 或指向工作项的 URL。多个工作项可以同时添加为子项。在极狐GitLab 16.5 中引入。 |
/award :emoji: | 是 | 是 | 是 | 切换表情符号反应。在极狐GitLab 16.5 中引入。 |
/cc @user | 是 | 是 | 是 | 提及一个用户。在极狐GitLab 15.0 及更高版本中,此命令不执行任何操作。你可以改为输入 CC @user 或仅 @user。 |
/checkin_reminder <cadence> | 否 | 是 | 否 | 调度 签到提醒。选项包括 weekly、twice-monthly、monthly 或 never(默认)。在极狐GitLab 16.4 中引入,带有名为 okrs_mvc 和 okr_checkin_reminders 的功能标志。 |
/clear_health_status | 是 | 是 | 是 | 清除健康状态。 |
/clear_weight | 是 | 否 | 否 | 清除权重。 |
/close | 是 | 是 | 是 | 关闭。 |
/confidential | 是 | 是 | 是 | 将工作项标记为机密。在极狐GitLab 16.4 中引入。 |
/copy_metadata <work_item> | 是 | 是 | 是 | 从同一命名空间中的另一个工作项复制标签和里程碑。<work_item> 值应为 #item 或指向工作项的 URL。在极狐GitLab 17.9 中引入。 |
/done | 是 | 是 | 是 | 将待办事项标记为已完成。在极狐GitLab 16.2 中引入。 |
/due <date> | 是 | 否 | 是 | 设置截止日期。有效的 <date> 示例包括 in 2 days、this Friday 和 December 31st。 |
/health_status <value> | 是 | 是 | 是 | 设置健康状态。<value> 的有效选项是 on_track、needs_attention 或 at_risk。 |
/label ~label1 ~label2 or /labels ~label1 ~label2 | 是 | 是 | 是 | 添加一个或多个标签。标签名称也可以不以波浪号(~)开头,但不支持混合语法。 |
/promote_to <type> | 是 | 否 | 是 | 将工作项提升为指定类型。<type> 的可用选项包括:issue(提升任务)或 objective(提升关键结果)。在极狐GitLab 16.1 中引入。 |
/reassign @user1 @user2 | 是 | 是 | 是 | 用指定的人员替换当前的受托人。 |
/relabel ~label1 ~label2 | 是 | 是 | 是 | 用指定的标签替换当前标签。 |
/remove_due_date | 是 | 否 | 是 | 移除截止日期。 |
/remove_child <work_item> | 否 | 是 | 否 | 移除子项 <work_item>。<work_item> 值应为 #item、group/project#item 或指向工作项的 URL。引入于极狐GitLab 16.10。 |
/remove_parent | 是 | 否 | 是 | 移除父工作项。引入于极狐GitLab 16.9。 |
/reopen | 是 | 是 | 是 | 重新打开。 |
/set_parent <work_item> | 是 | 否 | 是 | 设置父工作项为 <work_item>。<work_item> 值应为 #item、group/project#item 或指向工作项的 URL。引入于极狐GitLab 16.5。别名 /epic 用于具有新外观的议题,在极狐GitLab 17.10 中引入。 |
/shrug | 是 | 是 | 是 | 添加 ¯\_(ツ)_/¯。 |
/subscribe | 是 | 是 | 是 | 订阅通知。引入于极狐GitLab 16.4 |
/tableflip | 是 | 是 | 是 | 添加 (╯°□°)╯︵ ┻━┻。 |
/title <new title> | 是 | 是 | 是 | 更改标题。 |
/todo | 是 | 是 | 是 | 添加待办事项。引入于极狐GitLab 16.2。 |
/type | 是 | 是 | 是 | 将工作项转换为指定类型。<type> 的可用选项包括:issue、task、objective 和 key result。引入于极狐GitLab 16.0。 |
/unassign @user1 @user2 | 是 | 是 | 是 | 移除指定的受托人。 |
/unassign | 否 | 是 | 是 | 移除所有受托人。 |
/unlabel ~label1 ~label2 or /remove_label ~label1 ~label2 | 是 | 是 | 是 | 移除指定的标签。 |
/unlabel or /remove_label | 是 | 是 | 是 | 移除所有标签。 |
/unlink | 是 | 是 | 是 | 移除与提供的工作项的链接。<work item> 值应为 #work_item、group/project#work_item 或完整的工作项 URL。引入于极狐GitLab 17.8。 |
/unsubscribe | 是 | 是 | 是 | 取消订阅通知。引入于极狐GitLab 16.4。 |
/weight <value> | 是 | 否 | 否 | 设置权重。<value> 的有效选项包括:0、1 和 2。 |
提交消息
以下快捷操作适用于提交消息:
命令 | 动作 |
---|---|
/tag v1.2.3 <message> | 使用可选消息标记提交。 |
故障排除
快捷操作未执行
如果您运行快捷操作,但没有任何事情发生,请检查在输入时快捷操作是否出现在自动完成框中。如果没有,可能是因为:
- 与快捷操作相关的功能根据您的订阅等级或群组或项目的用户角色不可用。
- 快捷操作的必要条件未满足。例如,您在一个没有任何标签的议题上运行 /unlabel。