集成禅道和svn

Posted 2020-06-18 小小猫钓小小鱼

转载：http://www.zentao.net/book/zentaopmshelp/137.html

说明：svn集成功能配置会比较复杂，我们会尽量通过文档来帮助大家配置成功！如果实在配置不成功的，可以考虑找我们做收费技术支持。

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

一、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一键安装包，里面已经内置了svn.exe的客户端。在\xampp\silksvn目录下面。
3. 如果在windows下面自己安装，可以考虑下载slilksvn的客户端软件，安装。

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

3.1 代码位置

svn模块的配置文件位于zentao/module/svn/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路径。

$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.2 进入到zentao/bin/目录下面，执行syncsvn.bat或者syncsvn.sh脚本。

5.3  程序运行的效果图:

5.4 查看相应的bug:

六、部署定时任务

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

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

七、注意事项：

建议不要使用https或者ssh协议来访问，因为牵扯到https和ssh证书的验证交互问题，操作起来会比较麻烦。