大家在二次开发过程中,好的功能也可以打包成插件和大家进行分享。我们整理了禅道项目管理软件打包规范。
一、可以扩展的元素:
二、doc目录应当包含的文档
doc目录下面包含了插件的配置信息,按照语言进行存储,比如英文版本的,存为en.yaml,中文zh-cn.yaml
可以参考:
三、db目录下面包含的文件:
db目录下面可以包含install.sql和uninstall.sql。顾名思义,install.sql是当安装插件的时候执行的sql语句,而uninstall.sql则是当卸载插件的时候需要执行的sql语句。这样如果你的插件涉及到数据库的改动,可以将相应的sql语句放在这两个文件中,禅道的插件管理程序会自动来执行。
四、module下面的文件:
五、主配置文件的扩展
在实际过程中,可能会需要对全局的配置文件进行扩展,这种情况将扩展的配置文件放在zentao/config/ext/下面就可以了。
六、安装和删除的钩子脚本
如果在安装之前,安装之后,卸载之前,卸载之后需要执行一些操作,可以建立一个hook目录,然后分别在里面创建preinstall.php, postinstall.php, preuninstall.php, postuninstall.php,里面放上你所需要的代码即可。
七、小结:创建自己的插件:
- 确定插件的英文名,比如叫做hello。
- 在hello目录下面创建doc目录。
- 在doc目录下面创建配置文件yaml文件:
- 如果有涉及到数据库的改动,在hello目录下面创建db目录,分别写好install.sql和uninstall.sql
- 如果需要钩子脚本,创建hook目录,创建 preinstall.php, postinstall.php, preuninstall.php, postuninstall.php。
- 打包,使用zip格式将整个hello目录打包成hello.zip,就可以了。