研发效能工作流自动化——基于飞书集成平台的实践

不二家 · 2022年11月05日 · 最后由不二家回复于 2022年11月07日 · 7146 次阅读

什么是工作流自动化？

工作流自动化根据业务规则设计和执行一系列重复的业务任务，以减少人际交互，提高生产力。工作流是为实现业务目标而必须完成的一系列任务；
举个例子，如果你是 MacOS 用户，也许用过 “自动操作 Automator” 的应用，它是 Mac 系统自带的任务流自动化工具，只需要拖拽鼠标等操作就能将一系列动作组合成一个工作流程，从而帮助你自动完成一些重复任务，比如，定时打开聊天框发送邮件消息到指定用户等；
市面上有比较成熟的付费工作流自动化平台 Zapier / tray.io，也有开源的替代工具 n8n，今天介绍的是飞书集成平台，它的口号是让企业的业务系统集成更标准、更安全、更简单，解决企业内部应用互联、业务自动化等问题，让信息的传递更高效，让企业内的信息充分互通。
简单的说，都是通过集成能力让一系列的人工重复操作，交由机器完成，实现降本提效；

通过 Gerrit Webhooks 关联飞书消息推送

原始诉求

研发期望 Gerrit Code Review 加人的时候，可以有飞书提醒；
其实现在是有提醒的，只是配置在 Gerrit 服务系统配置里面，配置的是邮件提醒，公司当前是重度飞书使用，邮箱基本已经闲置，研发有诉求，就开始干；

方案整理

其实回头看，要想实现这个简单的需求有许多办法，我们当前围绕飞书开放平台 open api 实现了完整的飞书能力的构建，通过 Jenkins Gerrit 插件可以监听到 Gerrit Code Review Added Events ，然后调用我们封装好的飞书消息推送的 API 就能实现；

由于对于飞书集成平台比较感兴趣，刚关注到它发布，借着这个需求可以完整实践一次；

回到这个需求本身，实现过程应该通过 Gerrit hooks 事件的消息推送，然后将消息推送到指定开发者；

Gerrit 有提供 Webhooks 的插件的能力，介绍文档；

通过插件可以将 Gerrit events 通过 REST API 发送到指定服务，然后实现消息提醒；

飞书集成平台提供了多服务外部集成能力；

实现过程

第一步，下载 Gerrit Webhooks 插件；

第二步，上传插件，通过 api 上传

curl --user xxx:xxx -X PUT \
-H "Content-Type:application/octet-stream" \
--data-binary @{plugins}.jar  'https://xxx.xxx.xx/a/plugins/{plugins}.jar'

最后，重启 Gerrit 服务生效插件；

开启 webhooks 通知

增加 webhook 到指定 respository，其中 /a/ 是开启 http auth；

其中参考文档 Gerrit Webhooks 文档地址；

curl --user xxx/xxx \
https://xx.xx.com/a/config/server/{plugins}~projects/{指定仓库}/remotes/{自定义}

curl --location --request PUT 'https://xx.xx.xx/a/config/server/{plugins}~projects/{指定仓库}/remotes/{自定义}' \
--header 'Content-Type: application/json' \
--header 'Authorization: xxxx' \
--data-raw '{
    "url": "https://open.feishu.cn/xxxx",
    "maxTries": 3,
    "sslVerity":  true,
    "events": ["reviewer-added"]
}'