集成禅道和git

实现上述功能有两个方案，一个方案是采用git自带的钩子机制，当有代码提交的时候，触发一个钩子脚本，然后分析注释，得出相应的bug, story或者task的id号，然后调用禅道的api，将相关的记录写入数据库。还有一个方案是通过git客户端软件的log命令，来获得所有的提交记录，然后分析，得出相应的id，写入数据库。

上述两个方案各有各自的优缺点，我们终是选择了第二个方案。因为第二个方案调试比较好调试，部署也相对方便，同时可以解析之前的所有记录，有比较好的灵活性。

二、在禅道所在机器上面部署git命令行客户端。

git命令行客户端是指git自带的git命令。windows下面是git.exe，linux下面是没有后缀的git。

目前禅道只能集成禅道所在的机器上的git仓库，如果是远程仓库需要在禅道所在机器上克隆一个仓库（需要定时同步数据）进行集成。

如果是linux机器，需要安装git的客户端。rhel,centos可以用yum安装git, debian下面可以用apt-get install。

三、配置禅道关于git的参数

从禅道开源版12.1版本开始，配置GIT代码库方法是：请使用管理员登录禅道，在集成 - 代码库中进行配置（具体方法在 https://www.zentao.net/book/zentaopmshelp/393.html 集成版本库、集成Jenkins，并进行构建），无须再按步骤三操作，配置好后看步骤四。

3.1 代码位置

git模块的配置文件位于zentao/module/git/config.php。您可以直接修改这个文件，但建议您将改动保存到git/ext/config/git.php中。这样将来我们升级，就不会覆盖您的配置文件。

3.2 配置内容

1. git客户端命令的位置。

2. 库(repo): 可以配置多个库。

下面让我们用实际的例子来说明。

3.2.1 如下图，找到图中红框标志的位置

3.2.2 修改代码

写法如下面例子所示

$config->git->client 填写git客户端路径；

$config->git->repos[$i]['path'] 填写git库的路径

3.3 配置多个库

3.3.1 同上，在同一个文件里找到如下代码

3.3.2 修改代码

①将代码中的“/*”和”*/“删除，其余修改同上，注意：$i ++ 不可修改。

②如果还有git库，复制此段代码，进行同样的配置即可。

四、代码提交注释格式

开发者在提交代码到git的时候，需要在备注里面注明此次修改相关的需求，或者任务，或者bug的id。比如下面的格式：

bug#123,234, 1234，也可以是bug:123,234 1234，id列表之间，用逗号和空格都可以。

story#123 task#123

bug, story, task是必须标注的。:)

五、执行git同步命令

如管理员登录禅道后，有后台 - 系统 - 定时功能，则根据实际情况在这里设置执行时间周期即可( moduleName=git)

5.1 参考《初始化管理脚本》这篇文章初始化命令行的脚本。

5.2 进入到zentao/bin/目录下面，执行syncgit.bat或者syncgit.sh脚本（如无此脚本文件，可以点击链接《初始化管理脚本》）。

5.3 程序运行的效果图:

5.4 查看相应的bug:

六、部署定时任务

6.1 上述命令部署好之后，将该命令加入定时任务。比如可以5分钟执行一次。

方案1：网页登录禅道后台-系统-定时，开启计划任务后点击激活同步git 脚本，注： 修改后需要执行如下操作：后台-系统-定时关闭 =》重启apache服务 =》开启后台-系统-定时。

方案2：使用操作系统自带的计划任务功能：windows下面使用控制面板-计划任务，linux下面使用crontab。

6.2 配置的代码库也要使用定时任务同步更新（需要自己写同步脚本，部署在操作系统的定时任务中），每隔5分钟git pull一下。

七、集成GitLab类型版本库

15rc3版本开始，禅道集成 GitLab类型版本库。
集成成功后，可以同步版本库历史记录，进行目录浏览，代码查看、追溯、diff 功能操作。
下面给大家介绍怎么集成 GitLab类型版本库。

7.1 创建 GitLab类型版本库

点击DevOps--版本库页右上角的创建按钮，即可进入版本库的创建页面。

在类型点击下拉选择 GitLab。

接下来需要填写 GitLab地址和Token。

GitLab地址：

填写 GitLab里的项目所在的服务器地址，即可访问到 GitLab里的项目的服务器地址。

比如我的 GitLab的项目访问地址是： https://gitlab.abc.com，那么 GitLab地址就填写： https://gitlab.abc.com即可。

Token：

按照页面提示，根据使用需要填写内容信息。

填写完信息后，点击创建按钮。

Token 创建成功后，会提示在页面顶部。

创建 Token成功页面底部，还显示着之前创建成功的 Token列表信息。

填写 GitLab地址和Token后，项目会自动同步显示 GitLab里所有项目。

可以在下拉里选择。

选择了项目后，名称会自动填充为该项目的名称，点击保存即可。

保存成功后，就开始自动同步项目的代码。

7.2 同步 GitLab 项目的代码

创建版本库后，开始同步代码。

同步完成后可以在代码里查看，也可以在版本库的列表里查看到GitLab类型的版本库。

7.3 代码的查看、追溯、diff

浏览查看代码目录

追溯

比较差异（diff功能）

发表评论

评论列表

2021-04-19 18:23:39

因为安全原因，需要检测客户端版本，请将版本号写入文件 C:\ZenTao\xampp\zentao\tmp\log\version_607d516611407.log
可以执行命令：C:\Git --version > C:\ZenTao\xampp\zentao\tmp\log\version_607d516611407.log

2021-04-20 09:05:13

根据提示，在服务器上，CMD运行：C:\Git --version > C:\ZenTao\xampp\zentao\tmp\log\version_607d516611407.log
建议和贵公司技术同事一起操作。

2021-02-23 13:22:12

配置好git后执行syncgit.sh只显示这个是什么原因？
[root@localhost bin]# ./syncgit.sh
2021-02-23 13:21:31 begin repo 1
2021-02-23 13:21:31

repo #1: /www/wwwroot/www.zentao.com/hisCode finished

2021-02-23 16:04:29

联系下官网顶部商务QQ，邀请加入技术交流群，群里方便截图确认问题。

2021-01-04 15:54:37

能否在任务/bug页显示git的提交信息?

2021-01-04 17:00:02

https://www.zentao.net/book/zentaopmshelp/393.html
可以看下这篇手册，里面介绍的能否满足需求。如果集成遇到问题，可以联系官网顶部的商务QQ，邀请加入技术交流群，群里沟通。

2020-10-15 20:48:26

禅道12.0版本
创建2个版本库成功后，在创建第三个的时候无法创建成功。是不是开源版本只支持2个版本库？或者说有其他的问题？

2020-10-16 08:50:08

开源版没有创建版本库数量的限制。
可以直接在群里截图咨询下。

2020-10-14 17:40:39

D:\xampp\zentao\bin>D:\xampp\php\php.exe D:\xampp\zentao\bin\ztcli "http://127.0.0.1/zentao/git-run"
2020-10-14 17:31:35 begin repo 1
2020-10-14 17:31:35 start from revision 0
2020-10-14 17:31:42 begin repo 2
2020-10-14 17:31:42 start from revision 0
2020-10-14 17:31:48 begin repo 3
2020-10-14 17:31:48 start from revision 0
执行zentao\bin\syncgit.bat无法获取到git log信息

2020-10-15 09:26:41

贵公司使用的禅道版本应该比较早了，新版本已经换了版本库的集成方式，不再需要手动创建脚本了。
可以升级到最新版本，参考文档重新集成下：https://www.zentao.net/book/zentaopmshelp/393.html
升级前请做好数据备份
升级请参考文档：http://www.zentao.net/book/zentaopmshelp/41.html
备份请参考文档：http://www.zentao.net/book/zentaopmshelp/42.html
也可以添加页面上方QQ，邀请进群后问题截图咨询下。

2020-10-15 17:54:05

禅道更新到12以后，集成-版本库配置了gitlab，然后页面一直显示“正在同步，请稍等”，无法切换到集成-代码页面。这时候怎么查看禅道是否已经有同步git代码，是否有存储在哪个目录下呢

2020-10-16 08:50:36

这里之前版本有过bug，新版本已经解决了，可以升级最新版本重新同步下。
升级前请做好数据备份
升级请参考文档：http://www.zentao.net/book/zentaopmshelp/41.html
备份请参考文档：http://www.zentao.net/book/zentaopmshelp/42.html

2020-10-14 15:15:31

gitlab配置好了以后，提交代码时commit_msg填写填写禅道上的bug编号，执行zentao\bin\syncgit.bat文件，bug任务中看不到gitlab上提交的相关信息

2020-10-14 17:37:41

联系下官网顶部商务QQ，邀请加入技术交流群，群里截图看下操作过程，方便确认问题。

2020-08-11 17:44:42

请问在这个路径下/opt/zbox/app/zentao/www/ 配置了php文件，但是访问的时候无法解析php，直接变为解析下载，这个怎么解决？

2020-08-12 09:19:48

在/opt/zbox/etc/apache/httpd.conf文件中，添加如下允许访问新增发PHP文件的配置，重启禅道服务再访问新增的PHP文件试一下。
<Files "文件名.php">
SetHandler application/x-httpd-php
</Files>

2020-07-15 21:58:28

请问如果配置gitlab web-hook方式更新？

2020-07-16 08:42:24

目前还没有这种功能，可以先修改代码实现下，可以参考文档：
http://www.zentao.net/book/zentaopmshelp/156.html
http://www.zentao.net/book/zentaopmshelp/225.html

2020-05-22 16:26:24

<html><meta charset='utf-8'/><style>body{background:white}</style><script>alert('目录 /var/opt/gitlab/git-data/repositories/HSMC_CIM_Automation/fwp/ 不存在') </script> <html><meta charset='utf-8'/><style>body{background:white}</style><script>if(window.parent) window.parent.$.enableForm(); </script> parsererrorSyntaxError: Unexpected token < in JSON at position 0

2020-05-22 17:53:36

由于gitlab对git库访问权限有要求，而禅道集成git库时需要git库有apache的访问权限，这方面有冲突，所以暂时无法直接集成gitlab。
目前解决方法是，可以在本地克隆一个git库，定时同步这个克隆git库中的数据。将禅道和这个克隆的git库进行集成。
如果还是有问题，建议将库克隆到根目录下，给克隆库递归设置下777权限，再试试。
或者可以添加页面上QQ，邀请进群后具体问题咨询下，沟通会方便一些。

2020-05-16 11:55:14

12.3版本后台集成git，提示“目录不存在”是什么问题啊

2020-05-18 08:54:21

1. git 仓库地址填写的是必须是部署禅道的服务器目录地址，因为git仓库是没有远程http获取提交注释的接口所以只能在本机直接进行读取。
2. 排查下这个目录下是不是正确的git仓库，是不是有 .git 文件？
另外，如果还有问题，可以联系下官网顶部的商务QQ，邀请加入禅道技术交流群，进行沟通。

发表评论