DevOps

通过 generic-webhook-trigger 插件实时获取 Bitbucket Repository Events

背景

本篇讨论如何通过 Jenkins generic webhook trigger 插件来获取 Git 仓库事件（Events）。比如获取仓库的 Pull Request ID 等。

使用过 Jenkins Multi-branch pipeline Job 的用户知道，这个 Job 类型的环境变量中可以得到 Pull Request 的相关信息如下

Multi-branch pipeline Job 环境变量

为了获取这个变量需要创建这种类型的 Job，并且可能需要 clone 该仓库的代码，有点杀鸡宰牛的意思，看起来并不是一个特别恰当的办法。

如何通过创建一个普通的 Jenkins Job 就能实时获取 Bitbucket 仓库以及 Pull Request 事件呢？通过以下功能和插件可以实现。

  1. 配置 Bitucket 的 Webhook
  2. 通过 Jenkins generic-webhook-trigger 插件接收 Webhook 的 Event 事件

实现步骤

设置 Bitbucket Webhook

在需要监听的 Bitbucket 仓库中创建一个 webhook，如下：

  • Name: test-demo
  • URL: http://JENKINS_URL/generic-webhook-trigger/invoke?token=test-demo

创建一个 webhook

备注：Bitbucket 中还有一个另外一个设置项，根据我的测试，该设置项 Post Webhooks 与上面的 Webhooks 都能实现本文要实现的功能。

2. 配置 Jenkins Job

配置 Jenkins: 获取 Pull Request ID

想获取其他 Event 信息，比如 PR title, commit 等，请参考这个链接 bitbucket-server-pull-request.feature，按照上面的设置即可。

配置 Jenkins: token

这里的 token 值 test-demo 可以任意起名，但要与 Bitbucket event URL 中的 token 保持一致。

测试

  1. 在 Jenkins Job pipeline 里添加了这个代码片段 echo pr_id is ${pr_id} 用来检查输出 Pull Request ID 是否如预期。

  2. 然后在配置好的 Bitbucket 仓库下面创建一个 Pull Request

  3. Jenkins Job 被 Pull Request Open 事件自动触发并执行了

    Jenkins 通过事件别自动执行

  4. 通过 Jenkins 的输出日志看到成功获取到了这个 Pull Request ID 值

    获取到了 Pull Request ID

使用扩展

假如你有个程序，可以通过传入的 Pull Request ID 并借助 Bitbucket REST API 来获取并分析指定 Pull Request 的内容的。比如获取相关文件的历史记录，从而知道这些文件谁修改的最多以及这次修改涉及到了哪些 Jira 单号，从而做一些 Review 或是执行回归测试的推荐等等。

有了这个 PR ID 就可以通过 Jenkins 来自动触发去执行你程序了。

以上的这种方法适合不想或是不知道如何监听 Git 服务器（Bitbucket、GitHub 或是 GitLab 等）事件而需要要单独创建一个服务而准备的。如果你有什么很好的实践，期待你的留言分享。