gitlab bot

Gitlab通知機器人

• Gitlab通知機器人
  • 功能展示
  • 系統對接
    • 環境變數
    • 與企業微信對接
    • 與飛書對接
  • 應用部署運行
    • 使用Docker部署
    • 直接運行
  • 與Gitlab集成

將Gitlab的push 、 tag push 、 merge request和pipeline推送到第三方IM平台的機器人，如企業微信、飛書等；

1.0.0 : 採用內建程式碼，且僅支援企業微信；

2.xx : 透過訊息模板，可自行配置通知訊息格式和字段，具體配置方式，參見mustache官方文檔

todo:

• 使用mustache模板
• 增加note通知
• 增加system hook通知，參考gitlab system hook
• 支援飛書機器人
• 增加訊息模板設定檔
• 支援按天統計數據

---

功能展示

具體見下圖：

Gitlab push 程式碼推送

Gitlab push 新建分支

Gitlab push 刪除分支

Gitlab push tag 推標籤

Gitlab merge request 合併請求

Gitlab pipeline 管線

系統對接

環境變數

• PLATFORM ： qywx | feishu ，預設為qywx ，即：企業微信、飛書；
• WEBHOOK_URL_XXX ：機器人webhook位址，具體配置參考應用部署運行；
• SHOW_ORIGINAL ： true | false ，預設為false ，如果無模板，是否發送原消息體；

與企業微信對接

如何添加群組機器人可自行百度，企業微信群機器人配置說明。

與飛書對接

飛書群組裡添加機器人。飛書群機器人配置說明

飛書webhook位址範例：https://open.feishu.cn/open-apis/bot/v2/hook/UUID

應用部署運行

應用透過環境變數加入機器人webhook位址， WEBHOOK_URL_作為前綴，後面可接不同的推播群組。

如環境變數WEBHOOK_URL_PROJ ， PROJ則為推播群組。推送組用於與Gitlab的整合時使用。

例如：

• 機器人的webhook位址為：https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ABCDEFG
• 推送組為PROJ 。

則環境變數設為：

 WEBHOOK_URL_PROJ=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ABCDEFG

一個應用程式可以新增多個推送組。

使用Docker部署

修改docker-compose.yml檔案中的WEBHOOK_URL環境變量，新增企业微信机器人的webhook位址。

docker-compose up -d

透過:7001連接埠存取服務。

直接運行

首先系統安裝了node運行環境。

WEBHOOK_URL_PROJ=https://qyapi.weixin.qq.com/cgi-bin/webhook/send ? key=ABCDEFG npm start

透過:7001連接埠存取服務。

與Gitlab集成

進到項目， settings => integrations 。

URL填入服務的位址和連接埠號碼+推播群組。

例如，伺服器位址為：https://192.168.100.100:7001，推送群組為PROJ。

URL填寫：https://192.168.100.100:7001/proj

具體設置，請參閱下圖：