需在禅道后台依次完成添加Git代码库、配置同步计划、绑定项目、规范提交信息、验证关联效果五步操作,以实现需求/任务与代码提交的自动关联。

如果您在禅道中需要将项目与Git代码仓库进行关联,以便实现需求、任务与代码提交的自动关联,则需在禅道后台完成代码库的添加与配置。以下是完成此操作的具体步骤:
一、添加Git代码库
禅道支持通过内置的代码库管理模块接入Git仓库,需先在后台创建代码库条目,并填写正确的仓库地址、认证方式等基本信息,使禅道能识别并拉取仓库元数据。
1、使用管理员账号登录禅道,点击右上角【后台】进入后台管理界面。
2、在左侧菜单栏中,依次点击【版本控制】→【代码库】。
3、点击右上角【添加代码库】按钮。
4、在表单中填写以下必填项:名称(如:project-web)、类型选择“Git”、URL填写完整的Git仓库地址(如:https://gitee.com/username/project.git 或 git@github.com:username/project.git)。
5、若仓库为私有,需在【认证方式】中选择对应选项:使用用户名密码或SSH公钥;若选SSH,请确保禅道服务器已配置对应私钥并可免密访问该仓库。
二、配置代码库同步计划
添加代码库后,需设置定时同步任务,使禅道能定期获取分支、标签及提交记录,为后续关联提供数据基础。
1、返回【代码库】列表页,找到刚添加的代码库,点击右侧【编辑】图标。
2、勾选【启用同步】选项。
3、在【同步周期】中选择合适频率:建议首次设为“立即同步”+“每30分钟”,确保初始数据快速载入。
4、点击【保存】,系统将尝试连接仓库并拉取基本信息;若状态显示“同步失败”,请检查URL拼写、网络连通性及认证凭证有效性。
三、绑定项目与代码库
单一代码库可被多个项目引用,绑定操作建立项目维度的代码上下文,使需求/任务页面能展示对应仓库的提交记录与分支信息。
1、进入【项目】→【所有项目】,点击目标项目的名称进入项目总览页。
2、点击顶部导航栏中的【团队】→【代码库】子菜单。
3、点击【绑定代码库】按钮,在弹出的选择框中勾选已添加且状态为“已同步”的Git代码库。
4、点击【确定】完成绑定;绑定后,该项目下的需求、任务、Bug详情页将出现【相关代码】标签页。
四、提交信息规范以触发自动关联
禅道通过解析Git提交信息中的关键词(如“issue#123”、“bug#45”)匹配内部编号,从而实现代码与需求/缺陷的自动挂接,需统一团队提交格式。
1、在Git提交时,确保提交信息末尾包含标准格式的关联标记:issue#数字(对应需求)、task#数字(对应任务)、bug#数字(对应Bug)。
2、示例提交信息:feat: 实现用户登录校验逻辑 issue#87 task#203。
3、提交推送至远程仓库后,待下一次代码库同步完成,对应需求/任务/ Bug页面的【相关代码】区域将自动列出该次提交及链接。
五、验证关联效果
完成前述配置后,需通过实际提交与页面查看确认全流程是否生效,避免因格式错误或同步延迟导致关联缺失。
1、在已绑定代码库的项目中,新建一个需求,记录其编号(如:需求ID为156)。
2、本地执行Git提交,信息中包含issue#156,并推送至远程仓库。
3、等待同步周期结束(或手动点击代码库右侧【同步】按钮),刷新该需求详情页。
4、检查【相关代码】标签页是否出现本次提交记录,且提交哈希、作者、时间、消息均正确显示;若未出现,请核对提交信息格式、同步状态及项目绑定关系。

















