每次提交完代码,都要手动找到需求/Bug单修改状态?评论添加怎样更方便?工时每次都要手动填写?Smart Commit帮你解决这些问题。
(1)TAPD项目与工蜂Git仓库绑定;
(2)应用设置中开启「工蜂 Git」并完成 Smart Commit 配置,如何开启;
一、功能介绍:
1、Commit关键字+指令,触发需求/缺陷/任务状态流转
在代码提交信息中,插入「提交关键字+指令」,即可自动流转需求/缺陷/任务状态,效果如下:
使用步骤:(以需求为例,缺陷、任务同步支持)
① 打开需求详情页面,在左上角复制「源码提交关键字」
②返回工蜂/IDE提交页面,在Commit Message中粘贴「源码提交关键字」,并添加指令
③需求状态自动流转,并给当前操作人发送企业微信弹窗通知
指令关键字:目前已支持
输入格式:提交关键字+指令( 示例:--story=856106381 【小程序】登录页面优化 #finish )
批量操作:每一行提交关键字+指令,换行隔开
(示例:
--story=856106381 【小程序】登录页面优化 #finish
--story=856106382 【小程序】登录页面优化 #finish
)
2、Commit关键字+指令,为需求/缺陷/任务添加评论
在代码提交信息中,插入「提交关键字+指令」,即可自动添加评论,效果如下:
使用步骤与状态流转一致,在Commit Message中插入「源码提交关键字+指令」即可实现。
输入格式:提交关键字+指令 ( _ 示例: --story=856106381 【小程序】登录页面优化 #comment 需求已实现,请产品体验_ )
3、Commit关键字+指令,填写工时花费
在代码提交信息中,插入「提交关键字+指令」,即可自动填写工时花费,效果如下:
使用步骤与状态流转一致,在Commit Message中插入「源码提交关键字+指令」即可实现。
** 输入格式:** 提交关键字+指令 ( _ 示例: --story=856106381 【小程序】登录页面优化 #add 2.5h _ )
二、如何启用智能提交助手
使用智能提交助手(Smart Commit),需由 项目管理员 在项目下开启「工蜂 Git」应用,绑定代码仓库并配置操作规则。
具体步骤如下:
① 项目下启用「工蜂 Git」应用(已启用可跳过)
进入 ** 项目设置>应用设置 ,**选择「工蜂 Git」应用并开启
②关联Git代码库
进入 工蜂 Git>工具配置>获取 Webhook 配置信息
③配置Webhook
打开 Gitlab,在“代码项目设置”中,选择 Webhooks 设置,并填入配置信息。
三、配置说明与注意事项
状态流转
支持通过源码提交时插入 提交关键字+指令,自动触发需求/缺陷/任务 “状态A → 状态B”变更
注意事项:
(1)启用Smart Commit状态流转将允许跳过“状态A → 状态B”流转时填写字段,建议确认当前工作流中对于流转填写项要求,在不影响其它依赖项时启用;
(2)使用时,代码提交信息必须符合格式规范,创建成功如需消息通知到成员,建议通过自动化助手实现消息推送至项目成员。
若操作失败,请检查以下原因:
-
指令格式不规范,如未附带提交关键字、拼写错误、评论内容为空、工时单位(h/d)错误等;
-
需求/缺陷/任务不存在,请检查关键字是否正确;
-
Git代码库未与当前项目绑定,请参考①②步检查并确认;
添加评论
支持通过源码提交时插入 提交关键字+指令,在 需求/缺陷/任务 评论区域自动添加评论
注意事项:
-
评论内容不能为空
-
可以与状态流转、添加工时等功能配合使用,在提交关键字后附加多指令即可
填写工时花费
支持通过源码提交时插入 提交关键字+指令,在 需求/任务 下填写工时花费
注意事项:
-
工时单位为人时/人天,指令中必须附带单位h/d方可被系统识别;
-
工时花费内容,仅可填写整数或一位小数,超出后系统无法识别;
-
父需求和已拆分任务的需求,不支持填写花费信息;
-
当天仅允许填写一条工时花费记录,重复提交,将覆盖原记录内容;
四、配置自定义提交指令
除了系统指定的指令,还可以通过自动化助手实现自定义提交指令。
自动化规则创建入口:项目设置 > 自动化助手 > 添加自动化规则
每次提交完代码,都要手动找到需求/Bug单修改状态?评论添加怎样更方便?工时每次都要手动填写?Smart Commit 帮你解决这些问题。