如何在Jenkinsfile中设置HTML邮件

前言

来啦老铁!

前几天在改造我们团队自动化的时候,一时兴起想把我们的邮件报告,升级一下,想改改Jenkinsfile,把邮件样式改成HTML版本的,本想着应该是个很简单的活,没想到查资料+实现,花了我大半个下午,还是太年轻了,特做下记录,也供大家参考!

先给大家看下效果:

升级前的邮件
升级后的邮件

整体步骤

  1. 建立邮件模板;
  2. 修改Jenkinsfile;

1. 建立邮件模板;

在项目内任意位置建立邮件模板,如根目录下的email_template.html文件,邮件模板代码如下:

<!DOCTYPE html>
<html>

<head>
    <meta charset="UTF-8">
    <title>${ENV,var="JOB_NAME"}-${BUILD_NUMBER}</title>
</head>

<body leftmargin="8" marginwidth="0" topmargin="8" marginheight="4" offset="0">
    <table width="95%" cellpadding="0" cellspacing="0"
        style="font-size: 11pt; font-family: Tahoma,Arial,Helvetica,sans-serif">
        <tr>
            <td>THIS EMAIL IS SENT BY JENKINS AUTOMATICALLY, PLEASE DON'T REPLY!</td>
        </tr>
        <tr>
            <td>
                <h2>
                    <font color="#0000FF">BUILD RESULT - ${BUILD_STATUS}</font>
                </h2>
            </td>
        </tr>
        <tr>
            <td><br />
                <b>
                    <font color="#0B610B">DETAILS:</font>
                </b>
                <ht size="2" width="100%" byte="center" />
            </td>
        </tr>
        <tr>
            <td>

                <ul>
                    <li>PROJECT NAME&nbsp;:&nbsp;${PROJECT_NAME}</li>
                    <li>PROJECT URL&nbsp;:&nbsp;<a href="${PROJECT_URL}">${PROJECT_URL}</a></li>
                    <li>BUILD NUMBER&nbsp;:&nbsp;${BUILD_NUMBER}</li>
                    <li>STARTED BY&nbsp;:&nbsp;${CAUSE}</li>
                    <li>BUILD URL&nbsp;:&nbsp;<a href="${BUILD_URL}">${BUILD_URL}</a></li>
                    <li>BUILD LOG&nbsp;:&nbsp;<a href="${BUILD_URL}console">${BUILD_URL}console</a></li>
                    <li>BUILD WORKFLOW&nbsp;:&nbsp;<a
                            href="${PROJECT_URL}workflow-stage">${PROJECT_URL}workflow-stage</a></li>
                </ul>
            </td>
        </tr>
        <tr>
            <td>
                <font color="#0B610B">BUILD LOG (LAST 200 ROWS):</font></b>
                <hr size="2" width="100%" byte="center" />
            </td>
        </tr>
        <tr>
            <td><textarea cols="80" rows="30" readonly="readonly"
                    style="font-family: Courier New">${BUILD_LOG,maxLines=200,escapeHtml=true}</textarea>
            </td>
        </tr>
    </table>
</body>

</html>

稍微解读一下:

1). 模板内直接使用Jenkins的环境变量,如${BUILD_URL}、${BUILD_NUMBER}等;
2). 由于该模板全部动态使用Jenkins的环境变量,没有针对某个job的定制化代码,因此,该模板可以给任意job使用;
3). 该模板还包含了log,我们可以指定想在邮件里展示的log条数(本例为200条),关键代码:

<textarea cols="80" rows="30" readonly="readonly"
                    style="font-family: Courier New">${BUILD_LOG,maxLines=200,escapeHtml=true}</textarea>

2. 修改Jenkinsfile;

修改前的发邮件节点:
post {
    always {
        emailext (
            subject: "[${env.JOB_NAME}][${env.ENV}] #${env.BUILD_NUMBER}: Build ${currentBuild.currentResult}",
            body: "Details please refer to ${env.BUILD_URL}",
            attachLog: true,
            recipientProviders: [[$class: 'DevelopersRecipientProvider', $class: 'CulpritsRecipientProvider']],
            to: 'dylan.zhang@XXXX.com'
        )
    }
}
修改后的发邮件节点:
post {
    always {
        emailext (
            emailext(
            subject: "[${env.JOB_NAME}] [${env.ENV}] #${env.BUILD_NUMBER} : ${currentBuild.currentResult}",
            body: '${FILE,path="email_template.html"}',
            attachLog: true,
            recipientProviders: [[$class: 'DevelopersRecipientProvider', $class: 'CulpritsRecipientProvider']],
            mimeType: 'text/html',
            to: 'dylan.zhang@XXXX.com'        
        )
    }
}

稍微解读一下:

1). 关键点一,在body中指明信息来源:'${FILE,path="email_template.html"}';
2). 关键点二,指明邮件类型,mimeType: 'text/html';
3). 如果不是采用Jenkinsfile的,这些步骤可直接在job上配置,很类似;

运行Jenkins job完成后,就能顺利收到我们自定义的HTML邮件啦!该邮件模板对我来说已经足够用,毕竟相比之前的邮件报告,信息量多了不少,样式也还算可以,我们就不加入过多的花狸狐哨的东西啦!

回过头来看,整体实现还是挺简单的,只是当时查资料的时候,某度上查的资料都不全,都没有提到mimeType: 'text/html',最后在国外stack overflow某个帖子上看到这个信息,最终才顺利解决的,费了老大把劲!

今天就简单介绍到这啦!

如果本文对您有帮助,麻烦点赞+关注!

谢谢!

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