docs: 更新Readme

readme.md

@@ -1,4 +1,4 @@
-# CI 监控
+# 流水线监控
 
 监听新 projId，自动补全内容，获取从 20240101 到当前的所有流水线信息
 
@@ -10,11 +10,17 @@
 
 先从数据中获取用户信息填充，随后在根据填充完的用户信息获取全部的 userid 的列表，再写 pipeline 表
 
-# 图表库（不用了）
+# 流水线成功提醒
 
-https://g2plot.antv.antgroup.com/examples
+接收Gitlab 的 WebHooks请求，Secret 令牌 实际上为 Egg 的 API_KEY
 
-# 数据信息
+获取对应的MR信息，MR 的发起者也需要发送通知
+
+组织卡片信息，给 Commit的用户以及 可能的 MR发起者发送通知
+
+# 数据库表信息
+
+[数据库地址](https://ci-pb.xiaomiwh.cn/_/)
 
 project 信息
 
@@ -140,10 +146,12 @@ user 表
 }
 ```
 
-我想按天展示每个项目的 pipline 按 ref 区分的平均 duration，如何创建视图
+我想按天展示每个项目的 pipeline 按 ref 区分的平均 duration，如何创建视图
 
 # 机器人
 
+## CICD 统计总结
+
 卡片 ID：ctp_AAyVLS6Q37cL
 
 JSON 示例
@@ -180,3 +188,26 @@ JSON 示例
   "without_new_cicd_count": "20" // OK
 }
 ```
+
+## 流水线成功通知
+
+卡片 ID：ctp_AA36QafWyob2
+
+JSON 示例
+
+```json
+{
+  "project": "cloudml-visuals/fe/test",
+  "project_link": "https://git.n.xiaomi.com/cloudml-visuals/fe/test",
+  "pipeline": "8815519",
+  "pipeline_link": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/pipelines",
+  "ref": "preview",
+  "ref_link": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/commits/preview",
+  "commit_user": "赵英博",
+  "duration": "1m35s",
+  "participant": "赵英博、吴婷",
+  "commit_message": "chore: Add .gitlab-ci.yml for printing \"Hello, world!\"",
+  "mr": "cloudml-visuals/fe/cloud-ml-fe!374",
+  "mr_link": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/merge_requests/374"
+}
+```