gitlab bot

Gitlab notification bot

• Gitlab notification bot
  • Function display
  • System docking
    • environment variables
    • Connect with Enterprise WeChat
    • Connect with Feishu
  • Application deployment and running
    • Deploy using Docker
    • Run directly
  • Integrate with GitLab

Push Gitlab 's push , tag push , merge request and pipeline to robots on third-party IM platforms, such as Enterprise WeChat, Feishu, etc.;

1.0.0 : Uses built-in code and only supports Enterprise WeChat;

2.xx : Through message templates, you can configure the notification message format and fields by yourself. For specific configuration methods, please refer to the mustache official documentation.

todo:

• Use mustache templates
• Add note notification
• Add system hook notification, refer to gitlab system hook
• Support Feishu robot
• Add message template configuration file
• Support daily statistical data

---

Function display

See the figure below for details:

Gitlab push code push

Gitlab push new branch

Gitlab push delete branch

Gitlab push tag push tag

Gitlab merge request merge request

Gitlab pipeline pipeline

System docking

environment variables

• PLATFORM : qywx | feishu , the default is qywx , that is: Enterprise WeChat, Feishu;
• WEBHOOK_URL_XXX : robot webhook address, please refer to application deployment and operation for specific configuration;
• SHOW_ORIGINAL : true | false , the default is false , if there is no template, whether to send the original message body;

Connect with Enterprise WeChat

How to add a group robot can be done on Baidu and enterprise WeChat group robot configuration instructions.

Connect with Feishu

Add a robot to Feishu Group. Feishuqun robot configuration instructions

Feishu webhook address example: https://open.feishu.cn/open-apis/bot/v2/hook/UUID

Application deployment and running

The application adds the robot webhook address through environment variables, with WEBHOOK_URL_ as the prefix, which can be followed by different push groups.

For example, the environment variable WEBHOOK_URL_PROJ , PROJ is the push group. Push groups are used when integrating with Gitlab .

For example:

• The robot's webhook address is: https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ABCDEFG
• The push group is PROJ .

Then the environment variables are set to:

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

An application can add multiple push groups.

Deploy using Docker

Modify the WEBHOOK_URL environment variable in the docker-compose.yml file and add the webhook address of企业微信机器人.

docker-compose up -d

Access the service through port :7001 .

Run directly

First, the system installs node running environment.

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

Access the service through port :7001 .

Integrate with GitLab

Go to the project, settings => integrations .

The URL fills in the address and port number of the service + push group.

For example, the server address is: https://192.168.100.100:7001, and the push group is PROJ.

Fill in the URL: https://192.168.100.100:7001/proj

For specific settings, see the figure below: