Redmine与GitLab集成

怼烎@ 2021-11-09 01:36 515阅读 0赞

### 文章目录 ###

*  Redmine与GitLab集成
 *   *  前言
     *  在Redmine中配置版本库
     *   *  全局配置版本库
         *  生成Redmine的SSH Key
         *  配置项目版本库
         *  克隆项目代码库
     *  在Redmine上安装GitLab webhook插件
     *  在GitLab上配置webhook
     *  提交代码测试
     *  参考文档

# Redmine与GitLab集成 #

## 前言 ##

通过集成Redmine与GitLab可以实现Redmine工作项和代码的双向关联：

*  在Redmine的工作项详情页可以查看关联的代码提交记录
 *  代码提交后可以自动更新Redmine工作项的状态，并可登记工时

## 在Redmine中配置版本库 ##

### 全局配置版本库 ###

用管理员账号登录Remine，打开管理 / 配置 / 版本库。

在【启用SCM】菜单中勾选Git。

勾选“启用用于版本库管理的Web Service”，允许GitLab webhook访问Redmine。

在“版本库管理网页服务API密钥”后点击“生成一个key”，该key后面在配置GitLab webhook时会用到。

勾选“允许引用/修复所有其他项目的问题”。

勾选“激活时间日志”，勾选后可以在commit message中设置当前提交工时。

在该页面最后设置代码提交信息的关键字，当Redmine收到GitLab webhook消息时，将更新指定Redmine工作项的状态和完成比例，并登记工时。

### 生成Redmine的SSH Key ###

生成Redmine的SSH Key：

sudo su -s /bin/bash redmine
    whoami
    ssh-keygen -t rsa -b 4096
    cd ~/.ssh

将Redmine的SSH Public Key`id_rsa.pub`的内容添加到GitLab的SSH Key中。

### 配置项目版本库 ###

打开Redmine项目，打开配置 / 版本库。

点击“新建版本库”，选择SCM为Git，勾选“主版本库”，输入“标识”（比如`demo`），输入“库路径”（比如`/git-repo/demo`)，选择路径编码为UTF-8，勾选“报告最后一次文件/目录提交”。

### 克隆项目代码库 ###

克隆项目代码库（裸代码库，不包含代码）：

chown redmine:redmine /git-repo
    
    sudo su -s /bin/bash redmine
    cd /git-repo
    git clone --mirror git@gitlab.example.com:DevOpsDemo/demo.git demo

打开Redmine项目，打开“版本库”，查看是否可以看到代码库的代码和代码提交记录。

## 在Redmine上安装GitLab webhook插件 ##

用管理员账号登录Redmine，打开管理 / 插件，确保[Redmine GitLab Hook plugin ][Redmine GitLab Hook plugin] 已经安装。

## 在GitLab上配置webhook ##

打开GitLab项目，打开Settings / Integrations，输入URL类似`https://redmine.example.com/gitlab_hook?project_id=demo&key=<key>`

说明：

*  project\_id为Redmine上项目ID
 *  key为前面"全局配置版本库"步骤时生成的key

添加好webhook后，点击“Test”按钮，选择“Push events"测试GitLab webhook是否可以正常访问Redmine。

## 提交代码测试 ##

提交代码到GitLab，代码提交信息（Git commit message）类似`<keyword> #<id> <comment>`来测试是否可以自动更新Redmine工作项状态，是否可以在Redmine工作项详情页查看代码提交记录。

说明：

*  `<keyword>`为全局配置版本库时的关键字
 *  `<id>`为Redmine工作项编号
 *  `<comment>`为代码提交说明

## 参考文档 ##

*  [https://blog.csdn.net/hxpjava1/article/details/78522411][https_blog.csdn.net_hxpjava1_article_details_78522411]

[Redmine GitLab Hook plugin]: https://github.com/phlegx/redmine_gitlab_hook
[https_blog.csdn.net_hxpjava1_article_details_78522411]: https://blog.csdn.net/hxpjava1/article/details/78522411