用Jira webhook和Jenkins创建自动审批工作流

由于工作的原因,需要写一个自动审批的工作流,看了下网上的分享,资料不多;经过几天的踩坑,决定写这篇分享,不对之处欢迎指正

1. Jira创建一个工作流

首先创建一个工作流

2. Jenkins上安装插件 JIRA Trigger Plugin

2.1 安装plugin

Manage Jenkins -> Manage Plugin -> JIRA Trigger Plugin


JIRA Trigger Plugin

2.2 Jenkins配置Jira相关参数

Manage Jenkins -> Configure System -> JIRA Trigger Configuration


JIRA Trigger Configuration

3. Jira创建一个webhook

完成前面两部之后,开始创建webhook
Jira -> 系统 -> 高级 -> webhook 点击右上角创建webhook


image.png
新建webhook
  1. 名称:随便填写即可
  2. URL:{Jenkins的域名}/jira-trigger-webhook-receiver/
  3. 事件:这个字段的意义就是,在Jira上发生这个事件的时候,调起webhook,发起一个POST请求;这个地方填写的是JQL,也就是Jira的一个搜索语句,假如你只要某个项目的issue状态发生了变化,可以参照如图所示,在事件那栏写
project = 项目名称

保存之后,在浏览器输入刚刚webhook的URL,回车后如果提示这是一个POST请求


image.png

则表示webhook设置成功了!

4. Jenkins新建一个Job

总结一下webhook的工作原理:

  1. 在Jira上进行操作,触发了刚刚在webhook中设置好的事件,此时Jira服务器会调webhook的URL进行POST请求
  2. 此时请求会发到Jenkins,那么要如何触发job的执行呢,这就需要我们新建一个job来接收这个POST请求了

4.1 创建pipline job

也就是创建流水线的job,随便命名后,看到Build Triggers


Build Triggers
  1. 假如你只是想校验issue状态的变化,勾选Build when an issue is updated in JIRA ;如果你想校验的是issue评论发生的变化,勾选Build when a comment is added to JIRA(如果没有这个选项那一定是没有安装Jenkins的插件了,看前文)
    这里网上的说明也很多,不多说
  2. JQL filter 这个字段是当webhook的请求发来,会校验请求相关参数是否符合要求,可以和webhook填写的一致,也可以再加上更严格的筛选
  3. Changelog matcher:选择Add Changelog matcher,然后选择Jira Field Matcher;这个字段是校验webhook发来请求中的issue,是否是由某个状态(Old value)变为了某个状态(New value)
    这个状态的值需要从Jira获取(就是工作流每个阶段的名称啦)
  4. 保存job

其实到这里,整个webhook就可以用了,改变某个issue到指定状态,此job应当是会自动构建的,如果没有自动构建,那么要么是URL写错,要么是状态变更的错误,具体问题具体分析了。

5. webHook的传参

前面说到webhook发起的是POST请求,很有意思的一件事请就是参数是如何传的呢?

webhook页面,URL下面写了可以在URL中使用下面的额外变量,我以为只要点击某个变量,加到URL后,即可传递此参数,可是事实是加上参数后URL甚至都不能用了。
不知道是不是我使用的姿势有问题,看了很多网上的分享,我了解到webhook的URL被请求后,实际上是默认会传issue的key过去的,我们选择一个已经构建的job rebuild一次,可以看到确实传了参数issue key

那么其实其他的参数都是没有用的么?
也许是有用的,可能是我引用的参数不对,目前为止,我只发现不传参的时候URL是可以被自动调用的(欢迎指正)
可是这个issue key其实已经足够有用了,你可以通过调jira的api获得你想要的信息,下一篇讲如何在pipline中使用参数

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353