Jenkins进阶系列之——01使用email

  • 时间:
  • 浏览:1
  • 来源:UU快3直播官网

Ps:看着感觉很糙晕头,对比着Jenkins页面看要好些。

值得注意的是,拥有Hudson管理员权限是使用自定义Jelly脚本(该脚本没有跟email-ext打包)的前提。脚本的生成步骤一种我我真是相对简单:

1. Override Global Settings:不可能 不选,该插件将使用默认的E-mail Notification通知选项。反之,您还都可不可以 通过指定不同于( 默认选项)的设置来进行覆盖。

以上就是我介绍的Email-ext插件,不可能 本人的局限,对于它的使用没有更深的了解。参考资料[2]中还有关于它的扩展,你也还都可不可以 自行扩充它的功能。文章偏离 内容来源于参考资料[3]。不可能 您有关于该插件以及Jenkins使用的更多更好的感受,我期待与您一起分享。

 ●  Send to Committers:该邮件会发给上次构建时检查过代码的人员,该插件会基于提交者的ID和追加Jenkins配置页面的(default email suffix)默认邮件后缀来生成一个多多多多 邮件地址。譬如,上次提交代码的人是”first.last”, 默认的电子邮件后缀为“@somewhere.com”,没有电子邮件将被发送到“first.last@ somewhere.com”。 ●  Send To Requester:不可能 勾选,邮件将发送给构建触发者。 ●  Include Culprits:不可能 勾选,就是 “Send To Committers”勾选,邮件将暗含最后成功构建的提交者。 ●  More Configuration:通过单击”+(expand)”链接您能为每个邮件触发器作更多单独的设置。 ●  Recipient List:这是一个多多多多 以逗号(不可能 空格)分隔的可接受邮件的邮箱地址列表。不可能 触发就发送邮件到该列表。该列表会追上加”Global Recipient List”里。 ●  Subject:指定选者邮件的主题。注意:高级选项中的邮件触发器类型可覆盖对它的配置。 ●  Content:指定选者邮件的内容主体。注意:高级选项中的邮件触发器类型可覆盖对它的配置。

 ●  Remove通过单击指定触发器当前行的”Delete”按钮,给你删除该触发器。

3. 使用Jelly变量,让template匹配你的脚本名称(不须暗含后缀)。比如,脚本的名称为foobar.jelly,则邮件内容中应该是${JELLY_SCRIPT,template=”foobar”}。

所有的变量有无可选的,每个变量还都可不可以 如下表示,字符串类型使用name=“value”,而布尔型和数字型使用name=value。不可能 {和}标记上方没有变量,则不多被解析。示例:$TOKEN,${TOKEN},${TOKEN,count=30},${ENV,var=”PATH”}

(本邮件是多多线程 自动下发的,请勿回复!)<br/><hr/>

svn版本号:${SVN_REVISION}<br/><hr/>

项目名称:$PROJECT_NAME<br/><hr/>

注意:所有的触发器都不还都可不可以 配置一次。

构建地址:<a href=”$BUILD_URL”>$BUILD_URL</a><br/><hr/>

原文发布时间为:2018-11-11

文本格式:${JELLY_SCRIPT,template=”text”}

关于插件中默认的一个多多多多 Jelly脚本:一个多多多多 用来设计HTML格式邮件,原先 则是定义TEXT格式邮件。你能通过使用模板参数指定插件调用哪一个多多多多 脚本。它们的使用辦法 如下:

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.

2.1.1 全局属性详解



它主要含二个多多多多 偏离 :全局配置和项目配置。



当然,在一个多多多多 项目中应用email-ext插件并且,您还都可不可以 做或多或少全局的配置。现在先跳转到Jenkins的“系统设置”页面,如下图:

众所周知,Jenkins默认提供了一个多多多多 邮件通知,能在构建失败、构建不稳定等情況后发送邮件。就是它一种有全都局限性,比如它的邮件通知无法提供完全的邮件内容、无法定义发送邮件的格式、无法定义灵活的邮件接收配置等等。在原先 的情況下,给让让我们 歌词 找到了Jenkins Email Extension Plugin。该插件能允许你自定义邮件通知的方方面面,比如在发送邮件时给你自定义发送给谁,发送具体一种内容等等。本文不多告诉你怎么安装该插件,关于插件的安装请参考这里

下面解释一下常用的属性。

2.2.1.3 项目邮件变量

14. Enable Security:启用时,会禁用发送脚本的能力,直接进入Jenkins实例。不可能 用户试图访问Jenkins管理对象实例,将抛出一个多多多多 安全异常。

1 简述

8. Excluded Committers:补救邮件被邮件系统认为是垃圾邮件,邮件列表应该没有扩展的账户名(如:@domain.com),就是使用逗号分隔

7. Emergency reroute:不可能 一种字段不为空,所有的电子邮件将被单独发送到该地址(或地址列表)。

触发意味着:${CAUSE}<br/><hr/>

构建编号:$BUILD_NUMBER<br/><hr/>

11. Default Content:自定义邮件通知的默认内容主体。该选项能在邮件的内容中替换或多或少参数,原先 你就还都可不可以 在构建暗含有指定的输出信息。

释放个我的配置:

从Jenkins 2.9版本结束英语 英语 给让让我们 歌词 还都可不可以 使用Jelly脚本。Jelly脚本跟Hudson的API挂钩,能获得你不多的任何信息,全都它很强大。插件一个多多多多多 打包后的Jelly脚本,当然你也还都可不可以 自定义(脚本)。

 ●  ${DEFAULT_CONTENT}:这是Jenkins系统配置页面默认配置的邮件内容主体 ●  ${PROJECT_DEFAULT_SUBJECT}:这是项目的默认邮件主题。高级配置中使用该令牌的结果要优先于Default Subject字段。警告:不须在Default Subject 不可能 Default Content中使用该令牌,它会产生一个多多多多 未知的结果。

 ●  ${PROJECT_DEFAULT_CONTENT}:这是项目的默认邮件内容主体。高级配置中使用该令牌的结果要优先于Default Content字段。警告:不须在Default Subject 不可能 Default Content中使用该令牌,它会产生一个多多多多 未知的结果。

<hr/>

比如,项目配置页的默认主题和内容分别对应的是全局配置页面的DEFAULT_SUBJECT和DEFAULT_CONTENT,就是它会自动地使用全局的配置。同理,触发器中的Subject和Content分别对应的是项目配置页面的DEFAULT_SUBJECT和DEFAULT_CONTENT,全都它也会自动地使用项目的配置。不可能 变量中的“值”能暗含其它的变量,全都就能为变量快速地创建不同的切入点:全局级别(所有项目),专属级别(单一项目),触发器级别(构建结果)。

email-ext插件允许使用变量来动态插入数据到邮件的主题和内容主体中。变量是一个多多多多 以$(美元符号)结束英语 英语 ,并以空格结束英语 英语 的字符串。当一个多多多多 邮件触发时,主题和内容主体字段的所有变量有无通过真实的值动态地替换。同样,变量中的“值”能暗含其它的变量,都将被替上加真实的内容。

2. 把脚本存贴到 去JENKINS_HOME/email-templates文件夹里。

9. Default Subject:自定义邮件通知的默认主题名称。该选项能在邮件的主题字段中替换或多或少参数,原先 你就还都可不可以 在构建暗含有指定的输出信息。

构建情況:$BUILD_STATUS<br/><hr/>

4 总结

2.2.1.2 触发器类型

找到标题为“Extended E-mail Notification”的片段,你就能配置或多或少全局的email-ext属性。一种属性还都可不可以 匹配你SMTP邮件服务器的设置。一种节不仅能配置成Jenkins原有邮件通知的镜像(我真是有全都配置是一样的,但这是个不同的扩展点),就是还增加了或多或少额外的功能。输入框中名为 Default Subject 和 Default Content 的项允许你在全局级别配置邮件的内容。原先 做句子,还都可不可以 使您为所有的项目按您的需求做更好的、更简单的配置。如下图。

下面我解释一下常用的属性。

下面一个多多多多 图就是就是使用Jelly脚本生成的邮件(最新版Email-ext新增html_gamil模板,它跟html模板之类 ,全都这里不再显示它的截图):

2.2.1.1 项目高级配置

12. Default Pre-send Script:默认发送前执行的脚本(注:grooy脚本,这是我在某篇文章上看一遍的,不一定准确)。



你不多 编写属于本人的Jelly脚本。Jelly脚本能跟Jenkins 的API(包括hudson.model.AbstractBuild和hudson.model.AbstractProject)挂钩,因而很糙强大。不可能 你打算没有做,给你先参考现有的html和text脚本一探究竟。



Default Content:

要查看插件的高级配置,请点击”高级”按钮。该选项允许您各种类型的邮件触发器指定接收者。默认情況下,是没有配置的触发器,全都默认情況下不多发送邮件。要增加更多的触发器,选者“Add a Trigger”旁边下拉列表中的类型,它会增加到控件上方的列表中。一旦你增加了一个多多多多 触发器,你就还都可不可以 对它做或多或少选者。不可能 你点击一个多多多多 触发器旁边的”?”号,它将告诉你在一种条件下会触发邮件发送。如下图。

13. Enable Debug Mode:启用插件的调试模式。这将增加额外的日志输出,构建日志以及Jenkins的日志。在调试时是有用的,但不还都可不可以 用于生产。

 ●  Default Subject:允许你配置此项目邮件的主题。 ●  Default Content:跟Default Subject的作用一样,就是是替换邮件内容。 ●  Attach Build Log:附件构建日志。

 ●  Compress Build Log before sending:发送前压缩生成日志(zip格式)。



注意:这里只解释全局配置页面中缺少的变量。

变更集:${JELLY_SCRIPT,template=”html”}<br/><hr/>

HTML格式:${JELLY_SCRIPT,template=”html”}

2 配置

1. 创建Jelly脚本。脚本的名称应该是<名称>.jelly。名称以.jelly结尾是很糙要的。

不可能 给给你查看所有可用的变量,给你点击配置页的Content Token Reference的问号获取完全的信息。

当插件激活后你就能编辑如下字段(只列出常用的字段):

 ●  Unstable:即时发送构建不稳固的邮件。不可能 ”Still Unstable”触发器已配置,而上一次构建的情況是”Unstable”,没有”Still Unstable”触发器将发送一封邮件来替代(它)。 ●  Still Failing:不可能 两次或两次以上连续构建的情況为”Failure”,发送该邮件。 ●  Success:不可能 构建的情況为”Successful”发送邮件。不可能 ”Fixed”已配置,而上次构建的情況为“Failure”或“Unstable”,没有”Fixed”触发器将发送一封邮件来替代(它)。 ●  Fixed:当构建情況从“Failure”或“Unstable”变为”Successful”时发送邮件。 ●  Still Unstable:不可能 两次或两次以上连续构建的情況为” Unstable “,发送该邮件。

 ●  Before Build:当构建结束英语 英语 时发送邮件。

15. Content Token Reference:邮件中还都可不可以 使用的变量,所有的变量有无可选的。具体介绍请查看全局邮件变量章节。

3. Use List-ID Email Header:为所有的邮件设置一个多多多多 List-ID的邮件信头,原先 你就还都可不可以 在邮件客户端使用过滤。它不多 阻止邮件发件人大偏离 的自动回复(诸如拖累办公室、休假等等)。给你使用你习惯的任何名称不可能 ID号,就是给让让我们 歌词 还都可不可以 符合如下其中一种格式(真实的ID还都可不可以 要暗含在<和>标记里):

<ci-notifications.company.org>

Build Notifications <ci-notifications.company.org>

“Build Notifications” <ci-notifications.company.org>

关于更完全的List-ID说明请参阅RFC-2919.

10. Maximum Attachment Size:邮件最大附件大小。

2. Default Content Type:指定构建后发送邮件内容的类型,有Text和HTML一种.

要想在一个多多多多 项目中使用email-ext插件,你首先还都可不可以 在项目配置页激活它。在构建后操作——”Add Post-build Actions”选项中勾选”Editable Email Notification”标签。

Default Subject:构建通知:$PROJECT_NAME – Build # $BUILD_NUMBER – $BUILD_STATUS!

 ●  path文件路径,注意:是工作区目录的相对路径。 ●  ${BUILD_NUMBER} 显示当前构建的编号。 ●  ${JOB_DESCRIPTION} 显示项目描述。 ●  ${SVN_REVISION} 显示svn版本号。还支持Subversion插件出口的SVN_REVISION_n版本。 ●  ${CAUSE} 显示谁、通过一种渠道触发这次构建。 ●  ${CHANGES } -显示上一次构建并且的变化。 ●  showPaths 不可能 为 true,显示提交修改后的地址。默认false。 ●  showDependencies 不可能 为true,显示项目构建依赖。默认为false ●  format 遍历提交信息,一个多多多多 暗含%X的字符串,其中%a表示作者,%d表示日期,%m表示消息,%p表示路径,%r表示版本。注意,并有无所有的版本系统都支持%d和%r。不可能 指定showPaths将被忽略。默认“[%a] %m//n”。 ●  pathFormat 一个多多多多 暗含“%p”的字符串,用来标示怎么打印路径。 ●  ${BUILD_ID}显示当前构建生成的ID。 ●  ${PROJECT_NAME} 显示项目的全名。(见AbstractProject.getFullDisplayName) ●  ${PROJECT_DISPLAY_NAME} 显示项目的显示名称。(见AbstractProject.getDisplayName) ●  ${SCRIPT} 从一个多多多多 脚本生成自定义消息内容。自定义脚本应该贴到 去“$JENKINS_HOME/email-templates”。当使用自定义脚本有无默认搜索$JENKINS_HOME/email-templatesdirectory目录。或多或少的目录将不多被搜索。 ●  script 当其使用的并且,仅仅不还都可不可以 最后一个多多多多 值会被脚本使用(不还都可不可以 一起使用script和template)。 ●  template常规的simpletemplateengine格式模板。 ●  ${JENKINS_URL} 显示Jenkins服务器的url地址(给你再系统配置页更改)。 ●  ${BUILD_LOG_MULTILINE_REGEX}按正则表达式匹配并显示构建日志。 ●  regex java.util.regex.Pattern 生成正则表达式匹配的构建日志。无默认值,可为空。 ●  maxMatches 匹配的最大数量。不可能 为0,将匹配所有。默认为0。 ●  showTruncatedLines 不可能 为true,暗含[…truncated ### lines…]行。默认为true。 ●  substText 不可能 非空,就把这偏离 文字(就有无整行)插入该邮件。默认为空。 ●  escapeHtml 不可能 为true,格式化HTML。默认为false。 ●  matchedSegmentHtmlStyle 不可能 非空,输出HTML。匹配的行数将变为<b 4">3 Jelly脚本

2.1.2 全局邮件变量

4. Add ‘Precedence: bulk’ Email Header:设置优先级,更完全说明请参阅RFC-3834.

2.1 全局配置

5. Default Recipients:自定义默认电子邮件收件人列表。不可能 没有被项目配置覆盖,该插件会使用一种列表。您还都可不可以 在项目配置使用$ DEFAULT_RECIPIENTS参数包括此默认列表,以及上加新的地址在项目级别。上加抄送:cc:电子邮件地址之类 ,CC:someone@somewhere.com

提示:用英文逗号分隔变量的参数。

2.2 项目配置