Jenkins进阶系列之
1 简述众所周知,Jenkins默认提供了一个邮件通知,能在构建失败、构建不稳定等状态后发送邮件。但是它本身有很多局限性,比如它的邮件通知无法提供详细的邮件内容、无法定义发送邮件的格式、无法定义灵活的邮件接收配置等等。在这样的情况下,我们找到了Jenkins Email Extension Plugin。该插件能允许你自定义邮件通知的方方面面,比如在发送邮件时你可以自定义发送给谁,发送具体什么内容等等。本文不会告诉你如何安装该插件,关于插件的安装请参考这里。 2 配置它主要包含两个部分:全局配置和项目配置。 2.1 全局配置当然,在一个项目中应用email-ext插件之前,您必须做一些全局的配置。现在先跳转到Jenkins的“系统设置”页面,如下图:
找到标题为“Extended E-mail Notification”的片段,你就能配置一些全局的email-ext属性。这些属性必须匹配你SMTP邮件服务器的设置。这一节不仅能配置成Jenkins原有邮件通知的镜像(虽然有很多配置是一样的,但这是个不同的扩展点),而且还增加了一些额外的功能。输入框中名为 Default Subject 和 Default Content 的项允许你在全局级别配置邮件的内容。这样做的话,可以使您为所有的项目按您的需求做更好的、更简单的配置。如下图。
释放个我的配置: Default Subject:构建通知:$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS! Default Content: <hr/> (本邮件是程序自动下发的,请勿回复!)<br/><hr/> 项目名称:$PROJECT_NAME<br/><hr/> 构建编号:$BUILD_NUMBER<br/><hr/> svn版本号:${SVN_REVISION}<br/><hr/> 构建状态:$BUILD_STATUS<br/><hr/> 触发原因:${CAUSE}<br/><hr/> 构建日志地址:<a href="${BUILD_URL}console">${BUILD_URL}console</a><br/><hr/> 构建地址:<a href="$BUILD_URL">$BUILD_URL</a><br/><hr/> 变更集:${JELLY_SCRIPT,template="html"}<br/><hr/> 下面解释一下常用的属性。 2.1.1 全局属性详解1. Override Global Settings:如果不选,该插件将使用默认的E-mail Notification通知选项。反之,您可以通过指定不同于( 默认选项)的设置来进行覆盖。 2. Default Content Type:指定构建后发送邮件内容的类型,有Text和HTML两种. 3. Use List-ID Email Header:为所有的邮件设置一个List-ID的邮件信头,这样你就可以在邮件客户端使用过滤。它也能阻止邮件发件人大部分的自动回复(诸如离开办公室、休假等等)。你可以使用你习惯的任何名称或者ID号,但是他们必须符合如下其中一种格式(真实的ID必须要包含在<和>标记里): 4. Add 'Precedence: bulk' Email Header:设置优先级,更详细说明请参阅RFC-3834. 5. Default Recipients:自定义默认电子邮件收件人列表。如果没有被项目配置覆盖,该插件会使用这个列表。您可以在项目配置使用$ DEFAULT_RECIPIENTS参数包括此默认列表,以及添加新的地址在项目级别。添加抄送:cc:电子邮件地址例如,CC:someone@somewhere.com 6. Reply To List:回复列表, A comma separated list of e-mail addresses to use in the Reply-To header of the email. This value will be available as $DEFAULT_REPLYTO in the project configuration. 7. Emergency reroute:如果这个字段不为空,所有的电子邮件将被单独发送到该地址(或地址列表)。 8. Excluded Committers:防止邮件被邮件系统认为是垃圾邮件,邮件列表应该没有扩展的账户名(如:@domain.com),并且使用逗号分隔 9. Default Subject:自定义邮件通知的默认主题名称。该选项能在邮件的主题字段中替换一些参数,这样你就可以在构建中包含指定的输出信息。 10. Maximum Attachment Size:邮件最大附件大小。 11. Default Content:自定义邮件通知的默认内容主体。该选项能在邮件的内容中替换一些参数,这样你就可以在构建中包含指定的输出信息。 12. Default Pre-send Script:默认发送前执行的脚本(注:grooy脚本,这是我在某篇文章上看到的,不一定准确)。 13. Enable Debug Mode:启用插件的调试模式。这将增加额外的日志输出,构建日志以及Jenkins的日志。在调试时是有用的,但不能用于生产。 14. Enable Security:启用时,会禁用发送脚本的能力,直接进入Jenkins实例。如果用户试图访问Jenkins管理对象实例,将抛出一个安全异常。 15. Content Token Reference:邮件中可以使用的变量,所有的变量都是可选的。具体介绍请查看全局邮件变量章节。 2.1.2 全局邮件变量Ps:看着感觉有点晕头,对比着Jenkins页面看要好些。 email-ext插件允许使用变量来动态插入数据到邮件的主题和内容主体中。变量是一个以$(美元符号)开始,并以空格结束的字符串。当一个邮件触发时,主题和内容主体字段的所有变量都会通过真实的值动态地替换。同样,变量中的“值”能包含其它的变量,都将被替换成真实的内容。 比如,项目配置页的默认主题和内容分别对应的是全局配置页面的DEFAULT_SUBJECT和DEFAULT_CONTENT,因此它会自动地使用全局的配置。同理,触发器中的Subject和Content分别对应的是项目配置页面的DEFAULT_SUBJECT和DEFAULT_CONTENT,所以它也会自动地使用项目的配置。由于变量中的“值”能包含其它的变量,所以就能为变量快速地创建不同的切入点:全局级别(所有项目),专属级别(单一项目),触发器级别(构建结果)。 如果你要查看所有可用的变量,你可以点击配置页的Content Token Reference的问号获取详细的信息。 所有的变量都是可选的,每个变量可以如下表示,字符串类型使用name=“value”,而布尔型和数字型使用name=value。如果{和}标记里面没有变量,则不会被解析。示例:$TOKEN,${TOKEN},${TOKEN,count=100},${ENV,var=”PATH”} 提示:用英文逗号分隔变量的参数。 下面我解释一下常用的属性。
2.2 项目配置要想在一个项目中使用email-ext插件,你首先必须在项目配置页激活它。在构建后操作——”Add Post-build Actions”选项中勾选”Editable Email Notification”标签。
2.2.1 项目基本配置当插件激活后你就能编辑如下字段(只列出常用的字段):
2.2.1.1 项目高级配置要查看插件的高级配置,请点击”高级”按钮。该选项允许您各种类型的邮件触发器指定接收者。默认情况下,是没有配置的触发器,所以默认情况下不会发送邮件。要增加更多的触发器,选择“Add a Trigger”旁边下拉列表中的类型,它会增加到控件上面的列表中。一旦你增加了一个触发器,你就可以对它做一些选择。如果你点击一个触发器旁边的”?”号,它将告诉你在什么条件下会触发邮件发送。如下图。
2.2.1.2 触发器类型注意:所有的触发器都只能配置一次。
2.2.1.3 项目邮件变量注意:这里只解释全局配置页面中缺少的变量。
3 Jelly脚本从Jenkins 2.9版本开始我们可以使用Jelly脚本。Jelly脚本跟Hudson的API挂钩,能获得你想要的任何信息,所以它很强大。插件有两个打包后的Jelly脚本,当然你也可以自定义(脚本)。 关于插件中默认的两个Jelly脚本:一个用来设计HTML格式邮件,另一个则是定义TEXT格式邮件。你能通过使用模板参数指定插件调用哪一个脚本。它们的使用方法如下: 文本格式:${JELLY_SCRIPT,template=”text”} HTML格式:${JELLY_SCRIPT,template=”html”} 你也能编写属于自己的Jelly脚本。Jelly脚本能跟Jenkins 的API(包括hudson.model.AbstractBuild和hudson.model.AbstractProject)挂钩,因而特别强大。如果你打算这么做,你可以先参考现有的html和text脚本一探究竟。 值得注意的是,拥有Hudson管理员权限是使用自定义Jelly脚本(该脚本没有跟email-ext打包)的前提。脚本的生成步骤本身其实相对简单: 1. 创建Jelly脚本。脚本的名称应该是<名称>.jelly。名称以.jelly结尾是很重要的。 2. 把脚本存放在JENKINS_HOME\email-templates文件夹里。 3. 使用Jelly变量,让template匹配你的脚本名称(不要包含后缀)。比如,脚本的名称为foobar.jelly,则邮件内容中应该是${JELLY_SCRIPT,template=”foobar”}。 下面两个图就是就是使用Jelly脚本生成的邮件(最新版Email-ext新增html_gamil模板,它跟html模板类似,所以这里不再显示它的截图):
4 总结以上就是我介绍的Email-ext插件,由于自己的局限,对于它的使用没有更深的了解。参考资料[2]中还有关于它的扩展,你也可以自行扩充它的功能。文章部分内容来源于参考资料[3]。如果您有关于该插件以及Jenkins使用的更多更好的感受,我期待与您一起分享。 5 参考资料[1]《Maven实战》第11章11.9邮件反馈。 [2]https://wiki.jenkins-ci.org/display/JENKINS/Email-ext+plugin |