How to develop GrimoireLab Gitee - X-lab2017/grimoirelab GitHub Wiki

0） 环境

同 How to run GrimoireLab Gitee - Source Code 编译运行

1)、 安装 Elasticseach, kibiter, MariaDB

同 How to run GrimoireLab Gitee - Source Code 编译运行

2)、安装各模块

先安装好各模块：

$ cd ../utils
$ ./build_grimoirelab -l debug --logfile /tmp/log --build --install --check \
  --relfile ../releases/gitee/0.1.0 --reposdir /tmp/repos  --reposfile repos-for-gitee.json \
  --venv /tmp/venv --install_venv /tmp/ivenv

下载好的仓库存放在 /tmp/repos, 安装好的 venv 位于 /tmp/ivenv, 如果想对某个模块进行修改，找到对应的仓库文件，修改保存后，在 venv 中重新编译运行即可查看修改效果。

以下将以修改 grimoirelab-elk-gitee 与 grimoirelab-sigils 为例，展示整个流程。

1、进入 ivenv

$ source /tmp/ivenv/bin/activate

2、修改 grimoirelab-elk-gitee 代码

$ cd /tmp/repos && ls
cereslib  grimoireelk        grimoirelab          kidash      manuscripts  perceval-finos  perceval-mozilla  perceval-puppet  sirmordred
graal     grimoireelk-gitee  grimoirelab-toolkit  kingarthur  perceval     perceval-gitee  perceval-opnfv    sigils           sortinghat

$ cd grimoireelk-gitee

# ===== Make your changes =====

# 先将原来的uninstall，不然覆盖不了
$ pip3 uninstall grimoire-elk-gitee

# 编译，参考：http://www.bjhee.com/setuptools.html
$ python3 setup.py develop

grimoirelab-sigils 代码的修改同理。

3、运行

除了采用 sirmordred -c setup.cfg 方式运行 sirmodred 外，Grimoirelab 还提供了另一种 micro-mordred 方式用来简单轻便地运行,参考：https://chaoss.github.io/grimoirelab-tutorial/sirmordred/micro-mordred.html。

# 进入配置文件所在目录
$ cd xxx/grimoirelab/default-grimoirelab-settings/

# 生成 raw index 及 enriched index。每次修改完 grimoireelk-gitee 可运行该命令更新。
$ micro.py --raw --enrich --cfg setup-secured-gitee-source-code.cfg --backends git gitee gitee:pull gitee:repo github github:pull github:repo

# 上传 Dashboard。每次修改完 grimoirelab-sigils 可运行该命令更新。
$ micro.py --panels --cfg setup-secured-gitee-source-code.cfg

# 如果需要的话，可打开 debug mod
$ micro.py --panels --cfg setup-secured-gitee-source-code.cfg --debug

大功告成！打开 http://localhost:5601/ 即可看到效果。

常见问题

Q: 我按步骤修改了grimoirelab-sigils 代码，为什么没见效果更新？

在更新grimoirelab-sigils 代码的时候，需要更新 release_date 字段，参考 https://github.com/X-lab2017/grimoirelab-sigils/issues/10