dev-raven

dev-raven是一个webhook转发服务，旨在帮助团队协作更加高效。它可以将各种webhook消息（例如gitlab的代码提交、PR、新建issue、issue回复以及状态变更等）转化为通知标题和通知内容，并发送到企业微信群、个人微信群、邮箱等。

使用dev-raven非常方便。您只需要部署服务，并通过参数指定from和to，就可以构造一个回调地址。然后，将回调地址配置到您的github或gitlab的webhook中，就可以开始接收通知了。

快速开始

通过配置可以通过dev-raven将github中的事件推送到企业微信，如图：

我们只需要构造以下地址并在github的webhook中配置:

https://r.tltr.top?from=gitlab&to=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx-xxxx

配置完成后即可在企业微信群中收到github的提交、issue事件了。

其中：

from是消息的来源类型，现支持的消息源有github，gitlab，aliyundocker to是转发目标，现支持的转发目标有企业微信机器人，以及和企业微信机器人有相同payload的endpoint。

注意：以上示例中的 https://r.tltr.top 是 dev-raven 的一个公网部署地址，如不希望使用公开的服务，需要替换成私有部署的地址。

部署与启动

docker

docker run --restart always \
iyjian/dev-raven

docker-compose

git clone https://github.com/iyjian/dev-raven.git
cd dev-raven
cp .env.sample .env
./start.sh

pnpm

git clone https://github.com/iyjian/dev-raven.git
cd dev-raven
cp .env.sample .env
pnpm i
pnpm start:dev

用法示例

以下是几个构造webhook转发服务的例子：

• 构造一个把github的事件消息转发到邮箱的webhook地址： https://r.tltr.top?from=github&to=mymail@address.com

• 构造一个把阿里云docker的事件消息转发到邮箱的webhook地址： https://r.tltr.top?from=aliyundocker&to=mymail@address.com

• 构造一个发送helloworld到企业微信群的webhook地址: https://r.tltr.top?from=raw&content=helloworld&to=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx-xxxx

from=raw 需要额外的参数 content=****，会将 content 里的内容作为文本发送，不做任何转换。

• 构造一个webhook地址，只是在http response中返回解析后的数据但并不做转发 https://r.tltr.top?from=github

如果不带 to 参数，则不会转发到任何地方，只是根据 from 做消息内容的转化，方便调试。