禅道集成svn的配置图文教程

禅道于2.2版本内置了svn集成功能，把禅道和用户代码进行有效关联，方便用户查看。这篇文章将给大家讲述如何配置禅道集成svn。 

相关下载：禅道2.2官方源代码

一、subversion集成机制说明

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

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

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

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

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

禅道所在的机器可以和subversion机器分开，不在一台机器上面。

1. 如果是linux机器，需要安装svn的客户端。rhel,centos可以用yum安装subversion, debian下面可以用apt-get install.
2. 如果最新下载的windows一键安装包2.2版本，里面已经内置了svn.exe的客户端。
3. 如果是之前版本的一键安装包，可以下载上文所说的svn客户端包。解压缩到zentao的目录。在usr/local/下面可以找到silksvn就对了
4. 如果在windows下面自己安装，可以考虑下载silksvn的客户端软件，安装。  

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

3.1 代码位置

    1、一键安装包：zentao/home/zentao/module/svn/config.php

    2、源码包：zentao包位置/module/svn/config.php

 

注意，您可以直接修改上述的config.php文件，但建议您将改动保存到svn/ext/config/svn.php中。这样将来我们升级，就不会覆盖您的配置文件。

3.2 配置内容

关于subversion参数的设置，一共有下面几个概念：

1.  svn客户端命令的位置。
2.  库(repo): 可以配置多个库。
3.  库的用户名和参数。

 

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

 

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

 

3.2.2 修改代码

写法如下面例子所示

 

 $config->svn->client 这个是用来存储svn客户端执行文件svn.exe路径的，源码包用户需自行下载svn客户端（也可下载svn包，解压后 upgrade\usr\local 目录下 silksvn 文件夹为svn客户端，将其部署到禅道所在环境中）；

 $config->svn->repos[$i]['path']  这个是用来存储svn代码路径的；

 $config->svn->repos[$i]['username'] 这个是用来存储svn登录用户名的； 如果不需要登录，可以保持为空。

 $config->svn->repos[$i]['password'] 这个是用来存储svn登录密码的。  

3.3 配置多个库

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

 

3.3.2 修改代码

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

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

四、代码提交注释格式：

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

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

story#123 task#123

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

五. 执行svn同步命令 

5.1 通用的执行方式

5.1.1 打开命令行，进入zentao目录的bin目录。windows的一键安装包是在home/zentao/bin目录下面 。

5.1.2 执行php ztcli http://禅道的访问路径/svn-run.html 或者 ?m=svn&f=svn  这里面的访问路径根据实际的进行修改。比如：

 

php ztcli http://pms.zentao.net/svn-run.html  PATH_INFO方式。
php ztcli http://pms.zentao.net/?m=svn&f=run GET方式。

 

这其中的php，需要换成php或者php.exe所在的路径。

 

关于ztcli的使用，可以看我们的文档。

 

5.2 一键安装包 

 

windows一键安装包版本我们做了一些方便的修改，可以在bin目录下面，直接执行syncsvn.bat命令即可。(2.2版本内置，之前的一键安装包需要下载我们的svn客户端包) 

 

5.3  程序运行的效果图:

5.4 查看相应的bug:

 

六、部署定时任务

 

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

windows下面使用计划任务，linux下面使用crontab。

主要注意的是，在部署计划任务的时候，svn同步命令需要在bin目录下面。因此需要先cd到bin所在的目录。比如

cd c:/zentao/home/zentao/bin; syncsvn.bat

cd /home/www/zentao/bin; php ztcli http://xxxx/svn-run.html