Jira 最好用的功能 - Automation Rule

概述

Atlassian在2020上半年推出了Jira Automation功能,使得无代码自动化与Jira Cloud原生功能完美融合。使用该功能可以帮助团队将重复且乏味的工作自动化;标准化的梳理和组织各种活动,并提供高效且低成本的实现方式。作为Jira Cloud的用户我们已经使用Jira Automation 一段时间了,在这里和大家分享下使用的经验和心得。

Automation 页面介绍

Automation rule 页面的入口总共有两处:

  • 每个项目的项目管理侧边栏中有 Jira Automation 的入口,可以直接进入该项目的管理界面,看到属于该项目,以及拥有者为当前用户的规则列表。
Automation rule 入口-Project Settings
  • 在系统设置的“System”页面侧边栏有另外一个入口,需要有系统管理员权限才能访问而,进入后可以看到所有的规则。
Automation rule 入口-System

Automation rule管理界面的规则页面,按照规则类型:全部规则、全局规则、项目规则对所有自动化规则进行了分类,用户可以自定义标签进行规则过滤。列表的每个条目展示了规则名称、拥有者、项目名称,开闭状态开关。单条规则可以进行复制、移出和导出操作。

Automation rule 管理界面

管理页面的右上角有“创建规则”按钮,旁边的“...”菜单中有“性能洞察”可以看到每条规则的执行次数,总时长和平均时长以及执行结果的数据。菜单的其它功能基本都是常规操作。

Automation rule 性能监控页面

Automation Rule介绍

规则详情

在创建规则的页面中,可以配置规则的详细信息以及规则的过程定义。在规则详情中除了通用的规则名称、描述外,还可以进行如下定义:

  • 规则的使用范围:这里可以指定单个项目,多个项目,还是所有项目。如果指定多项目或者所有项目,要求 Jira 的 plan 得是 Pro 以上,否则会限制触发的数量;
  • 允许其它规则触发;
  • 可以更改错误通知的方式;
  • 可以更改规则的拥有者;
  • 可以更改规则的执行者。
Automation rule 创建页面

触发器(Trigger)

每次创建自动化规则,第一个需要定义的就是触发器组件,该组件作为规则的输入,规则中的后续判断和执行均依赖这个组件进行触发。

Issue 触发器

这类触发器是目前我们会频繁使用到的触发器,这类触发器可以定义 Jira 中项目(Project)、迭代(Sprint)、版本(Version)、事务(Issue)的各种变化作为触发条件。是内容最为丰富的一类触发器,基本上覆盖了 Jira 上与事务相关的所有使用场景。

Issue 触发器

DevOps 触发器

这类触发器是用于代码、分支、构建、发布过程作为触发条件的触发器,需要这几类工具和 Jira 系统进行集成才能更好的使用。目前对这类触发器的使用我们在进行探索。

DevOps 触发器

Integrations 触发器

这是一个很有意思的触发器类型,定义这类触发器的时候 Jira 会生成一个 Webhook URL 用于接收其它系统发出的 webhook 请求,并可以接受 issue key 作为请求参数或者请求 body,或是触发一条 JQL 查询,或是不带任何数据的请求,用于触发后续规则。

Integrations 触发器

Scheduled 触发器

这是一个自定及计划安排的触发器,用于指定时间和指定周期触发后续规则,同事也支持 CRON 表达式的高级定义。

Scheduled 触发器

条件判断组件(Condition)

条件判断是当规则定义的触发条件触发后,用于判断后续规则如何执行的组件,Jira Automation 的条件判断相对比较简单,而且只能进行很简单的嵌套,但得益于 JQL 的强大过滤能力以及 Smart Values(下文会介绍)的灵活性,基本能们组绝大部分使用场景。

组件 描述
Advanced compare condition 用于比较两个值的条件判断,支持等于、包含、大小等基本逻辑,也可以使用正则表达式匹配进行判断,条件为真则继续执行后续规则。
If / else block 基本的 if else 判断,下面可以在嵌套一层除 If / else block 之外的条件判断组件,并可以多个条件组成与的关系。满足分支条件则继续执行后续规则。
Issue fields condition 用于判断事务的字段是否符合条件的组件,支持等于或包含逻辑,同时可以比较当前事务与触发事务、父事务、史诗事务、目标事务等关联事务的字段。
JQL condition Jira 传统艺能 JQL 的条件过滤,过滤出来的数据会进入后续规则的执行。和传统 JQL 不太一样的是,这里可以使用 smart-values,强强联合。
条件判断组件

执行组件(Action)

Issue actions

Jira 事务的增删改查操作基本上都在这里。

Issue actions

Notifications

用于进行通知的功能都在这里,我们目前常用的主要是 Send email 和 Send web request。

Notification actions

重点介绍一下的是 Send web request 功能。该功能可以自定义一个 http 请求,包括 header 和 body,并且可以把请求的 response 保存到 samrt-values 变量中,用于后续的规则执行。

send web request 配置页面

Software

Jira 上关于版本的操作,可以创建、发布、取消发布 Jira 项目中定义的版本,版本名称可以使用正则表达式进行匹配。

Software actions

Advanced

这部分是 Jira Automation 特有的能力,其中 Look issues,可以获得 JQL 过滤出来的事务数据,Create variable 可以给 smart value 自定义一个名称。

Advanced actions

分支组件(Branch)

使用分支组件可以将规则中一部分事务数据分离出来单独进行处理,而不会收到其他规则部分的影响。

Advanced branching

单独处理事务数据中某个 smart value 对象。可以给指定的 smart value 对象定义别名用于后续规则的处理。

Advanced branching 配置页面

Branch rule/related issues

在 Jira 中事务经常是相关联的,通过这个功能可以筛选出指定关联的事务用于后续规则的处理。

Branch rule/related issues 配置页面

Smart Value 介绍

Smart Values 是配合 Jira Automation 使用的又一强大特性,使用 smart values 可以在 automation 中非常方便的访问和操作 Jira 事务的数据。常用 smart value 获取数据主要有以下几方面:

  • 可以访问和操作几乎所有的 Jira 事务数据,包括:Issue、Changelog、Commit、User、Sprint、Version 等,以及 Jira Automation 自定义的一些数据,如:lookupIssue、webhookResponse 等。
    字段 smart value
    返回事务中的描述字段 {{issue.description}}
    返回事务的 key {{issue.key}}
    返回事务的当前状态数据 {{issue.status}}
  • 支持列表操作,包括:遍历、索引取值、求和平均等。
    字段 smart value
    返回子任务的平均故事点数 {{issue.subtasks.Story Points.average}}
    遍历事务的修复版本,并用“ - ”连接 {{issue.fixVersions.name.join(" - ")}}
    遍历事务的修复版本,打印版本名称和发布日期,使用“,”号分隔 {{#issue.fixVersions}}{{name}} {{releaseDate}}, {{/}}
  • 字符串操作,包括:大小写和数字的转换、拼接,正则表达式匹配,html、json、xml、url 的 encode 操作等。
    字段 smart value
    字符串比对 {{issue.summary.equals(“hello world!”)}} -> false
    字符串正则表达式匹配 {{issue.summary.match(".(lo).")}} -> lo {{issue.summary.match(".(o).")}} -> [o, o]
    字符串替换 {{issue.summary.replace("Hello","Goodbye")}} -> Goodbye World!

Smart values 的使用非常灵活,想进一步了解的可以参考官方 smart values 帮助文档

案例实践

根据不同 Component自动创建对应的 Sub-task

  1. 设定 Issue 触发器

    设定 Issue 触发器
  2. 添加条件判断组件

    添加条件判断组件
  3. 判断去重

    判断去重
  4. 创建新的 ticket

    创建新的 ticket

定期通过备注 Comment来提醒 Assignee 关闭 Ticket

  1. 设置 Scheduled 触发器
设置 Scheduled 触发器
  1. 设置 Action
设置 Comment 的默认值

总结

总的来说,Jira Automation 是一个操作简单但是功能强大的自动化工具,它能把 Jira 上很多需要重复人工劳动的工作以组件拖拽配置的方式进行自动化,极大降低了自动化的门槛。在我看来,Jira Automation 是 Jira 中最好用的功能,不接受反驳。🙅🏻♂️

参考资料

Jira smart value

Jira cloud automation

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

推荐阅读更多精彩内容