Dev to master, v2.2.0 finish feishu notification (#14)

* separate local config and default config * finish feishu (#12) * finish feishu, readme optimize feishu template * change feishu msg header * docker log => stdout stderr * add show original env * upgrade to 2.2.0

Author: goodideal

Dockerfile

@@ -5,7 +5,10 @@ ENV TIME_ZONE=Asia/Shanghai
 
 RUN \
  echo "${TIME_ZONE}" > /etc/timezone \ 
- && ln -sf /usr/share/zoneinfo/${TIME_ZONE} /etc/localtime
+ && ln -sf /usr/share/zoneinfo/${TIME_ZONE} /etc/localtime \
+ && mkdir -p /root/logs/gitlab-bot \
+ && ln -sf /dev/stdout /root/logs/gitlab-bot/gitlab-bot-web.log \
+ && ln -sf /dev/stderr /root/logs/gitlab-bot/common-error.log
 
 WORKDIR /app
 

README.md

@@ -16,7 +16,7 @@
 
 `1.0.0`: 采用内置代码，且仅支持企业微信；
 
-`2.0.0`: 通过消息模板，可自行配置通知消息格式和字段，具体配置方式，参见[mustache官方文档](https://github.com/janl/mustache.js)
+`2.x.x`: 通过消息模板，可自行配置通知消息格式和字段，具体配置方式，参见[mustache官方文档](https://github.com/janl/mustache.js)
 
 todo:
 
@@ -62,8 +62,10 @@ Gitlab pipeline 流水线
 
 ### 环境变量
 
-- `PLATFORM`：`qywx`, `feishu`，即：企业微信、飞书；
+
+- `PLATFORM`：`qywx | feishu`，默认为`qywx`，即：企业微信、飞书；
 - `WEBHOOK_URL_XXX`：机器人webhook地址，具体配置参考[应用部署运行](#应用部署运行)；
+- `SHOW_ORIGINAL`：`true | false`，默认为`false`，如果无模板，是否发送原消息体；
 
 ### 与企业微信对接
 
@@ -75,7 +77,8 @@ Gitlab pipeline 流水线
 
 ![alt gitlab-feishu](./docs/gitlab-feishu.png)
 
-webhook地址示例：https://open.feishu.cn/open-apis/bot/v2/hook/UUID
+
+飞书webhook地址示例：https://open.feishu.cn/open-apis/bot/v2/hook/UUID
 
 
 ## 应用部署运行

app/service/webhook.js

@@ -16,7 +16,9 @@ Mustache.escape = text =>
 // all customized variables start with GB_
 class WebhookService extends Service {
  async translateMsg(data = {}, platform, gitlabEvent) {
- const { template, response, color } = this.config;
+ const { template, response, color, showOriginal } = this.config;
+
+ const isShowOriginal = process.env['SHOW_ORIGINAL'] || showOriginal;
 
  // set templage, response, color code
  if (!template[platform]) {
@@ -58,6 +60,9 @@ class WebhookService extends Service {
  break;
  }
 
+ if (!content.length && isShowOriginal) content.push(JSON.stringify(data));
+ if (!content.length) return false;
+
  const { path, body } = this.response;
  this.setJsonValue(body, path, content.join());
  return body;

config/config.default.js

@@ -24,6 +24,7 @@ module.exports = appInfo => {
 
  // add your user config here
  const userConfig = {
+ showOriginal: false,
  supportPlatforms: ['qywx', 'feishu'],
  platform: 'qywx',
  response: {
@@ -50,7 +51,7 @@ module.exports = appInfo => {
  header: {
  template: 'blue',
  title: {
- content: 'Gitlab通知',
+ content: 'Gitlab机器人通知',
  tag: 'plain_text',
  },
  },

package.json

@@ -1,6 +1,6 @@
 {
  "name": "gitlab-bot",
- "version": "2.1.0",
+ "version": "2.2.0",
  "description": "",
  "private": true,
  "egg": {
@@ -28,8 +28,8 @@
  "node": ">=14.20.0"
  },
  "scripts": {
- "start": "egg-scripts start --title=egg-server-gitlab-bot",
- "stop": "egg-scripts stop --title=egg-server-gitlab-bot",
+ "start": "egg-scripts start --title=gitlab-bot",
+ "stop": "egg-scripts stop --title=gitlab-bot",
  "dev": "egg-bin dev",
  "debug": "egg-bin debug",
  "test": "npm run lint -- --fix && npm run test-local",