Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wyyxdgm/gitlab-dingtalk
将gitlab事件消息推送到钉钉，支持docker一键部署。支持消息模板
https://github.com/wyyxdgm/gitlab-dingtalk
dingtalk docker docker-compose express gitlab gitlab-events message-template
Last synced: 3 days ago
JSON representation
将gitlab事件消息推送到钉钉，支持docker一键部署。支持消息模板
- Host: GitHub
- URL: https://github.com/wyyxdgm/gitlab-dingtalk
- Owner: wyyxdgm
- Created: 2024-01-14T03:42:08.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-01-24T02:27:35.000Z (10 months ago)
- Last Synced: 2024-01-24T03:28:40.187Z (10 months ago)
- Topics: dingtalk, docker, docker-compose, express, gitlab, gitlab-events, message-template
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gitlab-dingtalk
[中文](./README_zh_CN.md)
Due to the inconsistent message formats between GitLab event notifications and DingTalk, a direct push is not feasible. This project serves as an intermediary service for message translation, which enables the push of GitLab events to DingTalk.
## Quick Start
### Preparation
1. Create a new robot and obtain `access_token`. Refer to this [document](https://open.dingtalk.com/document/robots/custom-robot-access)
2. Insert this link into GitLab's `webhook`: `http://${yourhost}:6688/webhook?access_token=${access_token}`
Note: This project supports both single robot and multiple robots mode. The default robot can be set by the environment variable `ACCESS_TOKEN`. For multiple robots, you only need to add the `access_token` parameter to the link for distinction. The links are as follows:
```bash
http://${yourhost}:6688/webhook # default robot
http://${yourhost}:6688/webhook?access_token=${access_token1} # robot with access_token1
http://${yourhost}:6688/webhook?access_token=${access_token2} # robot with access_token2
```
If the `ACCESS_TOKEN` environment variable does not exist and no parameter is passed, an error will be reported.
### Node
```bash
npm install -g pm2
git clone [email protected]:wyyxdgm/gitlab-dingtalk.git
cd gitlab-dingtalk && npm install
ACCESS_TOKEN=${access_token} && \
TEMPLATE=default && PORT=6688 && \
npm start
```
### Docker
Replace the `access_token` in the following code with the robot's `access_token`.
```bash
docker run -e ACCESS_TOKEN=${access_token} -e TEMPLATE=default -e PORT=6688 -p 6688:6688 -d wyyxdgm/gitlab-dingtalk
```
### Docker Compose
Create docker-compose.yml as follows:Replace `${access_token}` with the robot's `access_token`.
```yml
version: "3"
services:
app:
image: "wyyxdgm/gitlab-dingtalk"
restart: always
container_name: gitlab-dingtalk
ports:
- "6688:6688"
environment:
- ACCESS_TOKEN=${access_token}
- PORT=6688
- TEMPLATE=default
command: ["npm", "start"]
```
Execute
```bash
# Start up
docker compose -f docker-compose.yml up -d
# Shut down
docker compose -f docker-compose.yml down
```
## Message Templates
### Default Template
The default template file is at `src/templates/default/index.js`, you can directly modify it according to the [Template Standard](./src/templates/README.md). The code is as follows:
```js
/**
* text type
* text String Required Text content
* isAtAll Optional Whether copying everyone or not
*/
function text(text = "", isAtAll = false) {
return {
msgtype: "text",
text: {
content: text,
},
at: {
isAtAll: isAtAll,
},
};
}
/**
* link type
* text String Required Text content
* title String Required Message title
* picUrl String Required Display picture
* messageUrl String Required URL to be redirected after clicking the message
*/
function link(linkObject) {
return {
msgtype: "link",
link: linkObject,
};
}
module.exports = {
_: (_) => text(`gitlab event[${_.object_kind}]`), // default
push: (_) =>
link({
text: _.commits.map((c) => c.message).join("\n"),
title: `gitlab event[${_.object_kind}] by ${_.user_name}`,
picUrl: `${_.user_avatar}`,
messageUrl: `${_.repository.homepage}/commit/${_.checkout_sha}`,
}), // Push event
tag: () =>
link({
text: `tag:${_.ref}`,
title: `gitlab event[${_.object_kind}] by ${_.user_name}`,
picUrl: `${_.user_avatar}`,
messageUrl: `${_.repository.homepage}/tags/${_.ref.replace("refs/tags/", "")}`,
}), // Tag event
issues: () => null, // Issues event
coc: () => null, // Applying default, comment on commit event
comr: () => null, // Applying default, comment on MR event
coi: () => null, // Applying default, comment on issue event
cocs: () => null, // Applying default, comment on code snippet event
};
```
### Local Custom Template
1. Choose a local directory as the template directory, for example `./default`
2. Copy a version of [src/templates/default/index.js](src/templates/default/index.js) to `./default/index.js`.
3. Refer to [src/templates/README.md](./src/templates/README.md) to adjust the content of `./default/index.js`
4. Start it up using the following method:
- Docker
Replace `./default` with the path of the local template folder and `${access_token}`, then execute
```bash
docker run --privileged -e ACCESS_TOKEN=${access_token} \
-e TEMPLATE=default -e PORT=6688 -p 6688:6688 \
-v ./default:/opt/app/src/templates/default \
-d wyyxdgm/gitlab-dingtalk
```
- Docker Compose
Create a new file `docker-compose.yml`, the content is as follows:
```yml
version: "3"
services:
app:
image: "wyyxdgm/gitlab-dingtalk"
restart: always
container_name: gitlab-dingtalk
ports:
- "6688:6688"
environment:
- ACCESS_TOKEN=${access_token}
- PORT=6688
- TEMPLATE=default
volumes:
- ./default:/opt/app/src/templates/default
privileged: true
command: ["npm", "start"]
```
Replace `./default` with your local template folder path and `${access_token}`, then execute.
```bash
# Start up
docker compose -f docker-compose.yml up -d
```
### Multiple Local Templates
Create a new `templates` folder, for storing multiple template folders as follows:
```bash
./templates
├── default
│ └── index.js
├── template1
│ └── index.js
└── template2
└── index.js
```
- Docker
Replace `${template_name}` with the name of the local template subfolder, and `${access_token}`, then execute.
```bash
docker run --privileged -e ACCESS_TOKEN=${access_token} \
-e TEMPLATE=${template_name} -e PORT=6688 -p 6688:6688 \
-v ./tempaltes:/opt/app/src/templates \
-d wyyxdgm/gitlab-dingtalk
```
- Docker Compose
The content of `docker-compose.yml` is as follows:
```yml
version: "3"
services:
app:
image: "wyyxdgm/gitlab-dingtalk"
restart: always
container_name: gitlab-dingtalk
ports:
- "6688:6688"
environment:
- ACCESS_TOKEN=${access_token}
- PORT=6688
- TEMPLATE=${template_name}
volumes:
- ./tempaltes:/opt/app/src/templates
privileged: true
command: ["npm", "start"]
```
Replace `./templates` with your local templates folder path, replace the template name `${template_name}`, and `${access_token}`, then execute.
```bash
# Start up
docker compose -f docker-compose.yml up -d
```
## Event List
Refer to local gitlab `${host}/help/web_hooks/web_hooks`, For more detail events data, please refer to[EVENT.md](./src/templates/EVENT.md)
- [Push events](#push-events)
- [Tag events](#tag-events)
- [Issues events](#issues-events)
- [Comment on commit](#comment-on-commit)
- [Comment on merge request](#comment-on-merge-request)
- [Comment on issue](#comment-on-issue)
- [Comment on code snippet](#comment-on-code-snippet)
- [Merge request events](#merge-request-events)
#### Push events
- header: `X-Gitlab-Event: Push Hook`
- default template: Link
#### Tag events
- header: `X-Gitlab-Event: Tag Push Hook`
- default template: Link
#### Issues events
- header: `X-Gitlab-Event: Issue Hook`
- default template: Text
#### Comment on commit
- header: `X-Gitlab-Event: Note Hook`
- default template: Text
#### Comment on merge request
- header: `X-Gitlab-Event: Note Hook`
- default template: Text
#### Comment on issue
- header: `X-Gitlab-Event: Note Hook`
- default template: Text
#### Comment on code snippet
- header: `X-Gitlab-Event: Merge Request Hook`
- default template: Text
#### Merge request events
- header: `X-Gitlab-Event: Merge Request Hook`
- default template: Link