Jenkins构建后发送邮件

时间：2023-03-08 22:04:53

我们首先安装Jenkins邮件扩展插件“ Email Extension Plugin ”。

Jenkins和插件的安装方法见上一篇文章：http://qicheng0211.blog.51cto.com/3958621/1918912

一、系统配置

1、进入Manage Jenkins->Configure System，找到配置段“Jenkins Location”:

Jenkins构建后发送邮件

Jenkins URL ：jenkins的访问地址

System Admin e-mail address ：系统管理员邮件地址，即邮件头的发件人。

2、找到“Extended E-mail Notification”配置段:

Jenkins构建后发送邮件

SMTP server ：SMTP服务器，比如腾讯企业邮箱的SMTP服务器为smtp.exmail.qq.com。

Default Content Type ：邮件内容格式，可选Plain text和HTML。

Default Recipients ：默认的收件人列表，用逗号分隔。抄送或密送某个收件人可以在其邮箱前面加上cc:或bcc:。

Default Subject ：默认的邮件标题。

Default Content ：默认的邮件内容。

Enable Debug Mode ：开启插件的Debug模式，我们会在日志里看到更多信息。

其他配置保持默认即可。

最后点击save保存配置。

二、项目配置

下面我们进入项目配置，构建完成后发送邮件给项目人员。

1、在项目列表中选择“Editable Email Notification”。

Jenkins构建后发送邮件

“Always”的意思是每次构建后都发送邮件，不论构建是否成功。

我们还可以选择其他触发方式，举几个例子：

Before Build ：构建之前发送

Failure-Any ：构建失败时发送

Failure-1st ：构建由成功变成失败时发送（前一次构建成功，本次构建失败）

Success ：构建成功时发送

然后选择Trigger对应的收件人：

Recipient List ：项目默认的收件人列表

Requestor ：此次构建的发起用户（需要给用户配置邮箱；经测试只适用于手动构建）

最后保存项目配置。

全局邮件变量

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”}

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

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

  • ${FILE,path="PATH"} 包括指定文件（路径）的含量相对于工作空间根目录。
    • 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 style=”your-style-value”> html escaped matched line </b>格式。默认为空。
  • ${BUILD_LOG} 显示最终构建日志。
    • maxLines 日志最多显示的行数，默认250行。
    • escapeHtml 如果为true，格式化HTML。默认false。
  • ${PROJECT_URL} 显示项目的URL地址。
  • ${BUILD_STATUS} -显示当前构建的状态(失败、成功等等)
  • ${BUILD_URL} -显示当前构建的URL地址。
  • ${CHANGES_SINCE_LAST_SUCCESS} -显示上一次成功构建之后的变化。
    • reverse在顶部标示新近的构建。默认false。
    • format遍历构建信息，一个包含%X的字符串，其中%c为所有的改变，%n为构建编号。默认”Changes for Build #%n\n%c\n”。
    • showPaths,changesFormat,pathFormat分别定义如${CHANGES}的showPaths、format和pathFormat参数。
  • ${CHANGES_SINCE_LAST_UNSTABLE} -显示显示上一次不稳固或者成功的构建之后的变化。
    • reverse在顶部标示新近的构建。默认false。
    • format遍历构建信息，一个包含%X的字符串，其中%c为所有的改变，%n为构建编号。默认”Changes for Build #%n\n%c\n”。
    • showPaths,changesFormat,pathFormat分别定义如${CHANGES}的showPaths、format和pathFormat参数。
  • ${ENV} –显示一个环境变量。
    • var– 显示该环境变量的名称。如果为空，显示所有，默认为空。
  • ${FAILED_TESTS} -如果有失败的测试，显示这些失败的单元测试信息。
  • ${JENKINS_URL} -显示Jenkins服务器的地址。(你能在“系统配置”页改变它)。
  • ${HUDSON_URL} -不推荐，请使用$JENKINS_URL
  • ${PROJECT_URL} -显示项目的URL。
  • ${SVN_REVISION} -显示SVN的版本号。
  • ${JELLY_SCRIPT} -从一个Jelly脚本模板中自定义消息内容。有两种模板可供配置：HTML和TEXT。你可以在$JENKINS_HOME/email-templates下自定义替换它。当使用自动义模板时，”template”参数的名称不包含“.jelly”。
    • template模板名称，默认”html”。
  • ${TEST_COUNTS} -显示测试的数量。
    • var– 默认“total”。
      • total -所有测试的数量。
      • fail -失败测试的数量。
      • skip -跳过测试的数量。

更多变量参考：https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project

相关文章