集成禅道和git

简介：本篇文章讲述如何配置禅道集成git。

禅道从5.0版本开始内置了git集成功能，把禅道的任务、Bug等与代码进行关联，方便用户查看。下面向大家讲解如何配置禅道集成git。

一、 git集成机制说明

git集成的基本机制是：分析提交代码时的注释 => 得出相应的story, task, bugID => 写入到禅道的数据库。

实现上述功能有两个方案，一个方案是采用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的参数

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同步命令

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一下。