maubot/gitlab

Maunium GitLab机器人

概述和主要用途

Maunium GitLab机器人是一个面向Matrix的GitLab集成工具，使用https://github.com/tulir/mautrix-go/tree/legacy%E3%80%81https://github.com/go-playground/webhooks%E5%92%8Chttps://github.com/xanzy/go-gitlab%E5%BA%93%E5%BC%80%E5%8F%91%EF%BC%8C%E5%AE%9E%E7%8E%B0Matrix%E4%B8%8EGitLab%E7%9A%84%E6%97%A0%E7%BC%9D%E9%9B%86%E6%88%90%EF%BC%8C%E6%94%AF%E6%8C%81%E4%BA%8B%E4%BB%B6%E9%80%9A%E7%9F%A5%E5%92%8C%E9%A1%B9%E7%9B%AE%E7%AE%A1%E7%90%86%E5%8A%9F%E8%83%BD%E3%80%82

讨论

Matrix房间：#maulabbot:maunium.net

核心功能和特性

• GitLab Webhooks通知：通过GitLab webhooks向Matrix房间推送事件通知，包括：
  • Issues/合并请求（含评论）
  • 推送事件
  • 标签创建
  • 流水线事件
  • Wiki页面编辑
• GitLab账户登录：支持用户通过GitLab访问令牌登录（按用户独立配置）
  • [计划功能] 支持多GitLab服务器登录及按房间配置默认服务器
• 提交管理：
  • 查看完整提交消息
  • 查看提交差异
  • 查看提交历史
• Issue管理：
  • 读取issues
  • 创建/关闭/重新打开issues
  • 读取issue评论
  • 评论issues
• [待实现] 更简短的命令

使用场景和适用范围

适用于开发团队通过Matrix实时接收GitLab项目事件通知、管理代码提交和issues，提升团队协作效率，尤其适合需要集中化项目沟通的团队。

使用方法和配置说明

Docker部署

1. 创建机器人工作目录并进入：

   bash
   mkdir maulabbot && cd maulabbot
   

2. 拉取Docker镜像：

   bash
   docker pull docker.io/maubot/gitlab:latest
   

3. 配置文件准备：将示例配置文件example-config.json复制为config.json，并根据需求填写必要字段。
4. 启动容器：

   bash
   docker run --restart unless-stopped -v `pwd`:/etc/maulabbot:z docker.io/maubot/gitlab:latest
   

Webhooks配置

添加GitLab webhook时，需在URL中通过查询参数room指定目标Matrix房间ID。例如，若机器人webhook基础地址为https://example.com/webhook，完整webhook URL应格式化为：
https://example.com/webhook?room=!房间ID:matrix.org
机器人将向指定房间ID的Matrix房间发送事件通知。

命令使用

大多数命令需先通过GitLab访问令牌登录，在与机器人的私聊中执行登录命令：
!gitlab login <GitLab访问令牌>

机器人仅响应以!gitlab为前缀的命令，发送!gitlab help可获取完整命令帮助。