企业微信群消息通知 PRD

Problem to solve

User wants to receive Jihu Gitlab's events (issue, mr, pipeline...) notification in their WeCom group conversation.

Proposal

User Story

As a developer, I want to receive events from JiHu GitLab e.g. issue created, pipeline failure... in my WeCom conversations so that I can receive these updates in time.

Use Cases

1. User chooses to add a Bot in the WeCom group and copy the url of Webhook.
2. User opens a Jihu GitLab Group (or Project) Settings - Integration - WeCom Notification Service, and configures the service:
   1. Sends notifications about project events to WeCom group conversations. How do I set up this service?
   2. Enable integration
      • Active
   3. Trigger (each trigger allows to add multiple Webhook urls; When a text form is filled, a new form will pop up below it):
      • Push
      • Issue
      • Confidential Issue
      • Merge Request
      • Note
      • Confidential Note
      • Tag Push
      • Pipeline
      • Wiki Page
      • Deployment
      • Vulnerability
      • Alert
   4. Language:
      • 简体中文/English
   5. Notify only broken pipelines
   6. Branches for which notifications are to be sent
   7. Labels to be notified
   8. Labels to be notified behavior
   9. Save the configuration.

Useful Links

• 群机器人配置说明
• 推送消息文案模板

Acceptance Criteria

1. 配置页面根据当前issue中的Use Case能够配置成功
2. 实际使用中根据ChatOps PRD中所有event type消息都能成功发送至企业微信群聊聊天窗口
3. 企业微信群聊消息标题支持三种颜色，我们统一使用3种颜色，规定以下事件的标题颜色：
   • 绿色（Green）代表完成/成功
     • push
     • push to removed branch
     • tag push
     • issue&confidential issue open/close
     • MR open
     • MR merge
     • MR approve
     • Note & Confidential Note
     • Pipeline pass
     • Wiki
     • Deployment start
     • Deployment succeed
   • 红色（Red）代表错误/异常
     • MR unapprove
     • Pipeline fail
     • Deployment fail
     • Vulnerability detected
     • Alert detected
   • 灰色（Grey）代表失效
     • MR close
     • Pipeline cancel
     • Deployment cancel