# gitlab-wxwork-robot

**Repository Path**: mingyang100/gitlab-wxwork-robot

## Basic Information

- **Project Name**: gitlab-wxwork-robot
- **Description**: 集成Gitlab、Jenkins和企业微信。提升DevOps沟通效率。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: http://www.mingyang100.com
- **GVP Project**: No

## Statistics

- **Stars**: 22
- **Forks**: 10
- **Created**: 2020-02-15
- **Last Updated**: 2024-07-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gitlab通知机器人

将`Gitlab`的`push`、`tag push`、`merge request`和`pipeline`推送到企业微信的机器人。

具体见下图：

Gitlab push 代码推送

![alt gitlab-push-msg-1](./docs/gitlab-push-msg-1.png)

Gitlab push 新建分支

![alt gitlab-push-msg-2](./docs/gitlab-push-msg-2.png)

Gitlab push 删除分支

![alt gitlab-push-msg-3](./docs/gitlab-push-msg-3.png)

Gitlab push tag 推标签

![alt gitlab-push-tag-msg-1](./docs/gitlab-push-tag-msg-1.png)

Gitlab merge request 合并请求

![alt gitlab-mr-msg-1](./docs/gitlab-mr-msg-1.png)

Gitlab pipeline 流水线

![alt gitlab-pipeline-msg](./docs/gitlab-pipeline-msg-1.png)

## 与企业微信对接

如何添加群机器人可自行百度。企业微[信群机器人配置说明](https://work.weixin.qq.com/api/doc/90000/90136/91770)。


## 应用部署运行

应用通过环境变量添加机器人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
```

多个项目示例：

```
WEBHOOK_URL_PROJ1=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ABCDEFG
WEBHOOK_URL_PROJ2=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=HIJKLMN
```


一个应用可以添加多个推送组。

### 使用Docker部署

修改`docker-compose.yml`文件中的`WEBHOOK_URL`环境变量，添加`企业微信机器人`的`webhook`地址。

```bash
docker-compose up -d
```

通过`:7001`端口访问服务。

### 直接运行

首先系统安装了`node`运行环境。

```bash
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 （不区分大小写）

具体设置，参见下图：

![alt gitlab集成图片](./docs/gitlab-integration-1.png)

## Docker Hub 地址
https://hub.docker.com/repository/docker/mingyanggroup/gitlab-wxwork-robot