內(nèi)容來(lái)自于以下文章:
https://blog.csdn.net/fullbug/article/details/53024562
Jenkins是一個(gè)很受歡迎的CI持續(xù)集成工具,能夠?qū)崿F(xiàn)項(xiàng)目的自動(dòng)構(gòu)建、打包、測(cè)試、發(fā)布等。還可以在構(gòu)建失敗、構(gòu)建不穩(wěn)定等狀態(tài)后發(fā)送郵件通知。現(xiàn)介紹一下如何在Jenkins中配置實(shí)現(xiàn)郵件通知。
在Jenkins中配置實(shí)現(xiàn)郵件通知,Jenkins提供了兩種方式的配置。
一種是Jenkins內(nèi)置默認(rèn)的郵件通知,但是它本身有很多局限性,比如它的郵件通知無(wú)法提供詳細(xì)的郵件內(nèi)容、無(wú)法定義發(fā)送郵件的格式、無(wú)法定義靈活的郵件接收配置等等。
另外一種是通過(guò)安裝Email Extension Plugin插件,使用該插件來(lái)發(fā)送郵件通知。
不管哪種郵件通知都有全局配置和項(xiàng)目配置。其中全局配置是在Jenkins中系統(tǒng)管理的系統(tǒng)設(shè)置里面設(shè)置,項(xiàng)目配置在具體的項(xiàng)目中的配置中設(shè)置。
下面分別說(shuō)明Jenkins兩種郵件通知的配置。
示例中的Jenkins版本為Jenkins ver. 2.27
一、Jenkins內(nèi)置默認(rèn)的郵件通知配置
1、全局配置
點(diǎn)擊左邊的“系統(tǒng)管理”菜單,選擇右邊的“系統(tǒng)設(shè)置”
在系統(tǒng)設(shè)置中找到Jenkins Locaction項(xiàng)填入Jenkins URL和系統(tǒng)管理員郵件地址,系統(tǒng)管理員郵件地址一定要配置,否則發(fā)不了郵件通知。因?yàn)猷]件通知都是由系統(tǒng)管理員的郵箱發(fā)出來(lái)的。
找到郵件通知項(xiàng),填入SMTP服務(wù)器信息及用戶(hù)名、密碼等認(rèn)證信息。
配好以后勾選“通過(guò)發(fā)送測(cè)試郵件測(cè)試配置”
填入接收測(cè)試郵件的地址,點(diǎn)擊“Test configuration”。如果配置正確就會(huì)在下面顯示Email was successfully sent
在測(cè)試接收郵箱就會(huì)收到由Jenkins系統(tǒng)管理員的郵箱發(fā)出來(lái)的一封測(cè)試郵件。說(shuō)明郵箱通知確實(shí)已經(jīng)配置正確并能夠正常收發(fā)Jenkins的通知郵件了。有網(wǎng)友說(shuō)如果配的發(fā)送郵箱是某個(gè)郵件服務(wù)商的比如163的郵件,接收郵箱也得要配相同郵件服務(wù)商163的才可以收到郵件,經(jīng)過(guò)測(cè)試沒(méi)有這種限制,只要是能夠收發(fā)郵件隨便配哪個(gè)郵件服務(wù)商126、163、QQ、189甚至公司郵件等的都可以收。
2、項(xiàng)目配置
郵件通知的全局設(shè)置配好以后就可以在具體的項(xiàng)目中應(yīng)用發(fā)送郵件通知了。
在項(xiàng)目的設(shè)置中找到“增加構(gòu)建后的操作步驟”,選擇“E-mail Notifacation”通過(guò)E-mail通知。
在Recipients中填入郵件通知接收者中,如果有多個(gè)接收者用空格分隔,可以發(fā)送郵件通知給多個(gè)相關(guān)的接收人。
如果配置沒(méi)有問(wèn)題,在構(gòu)建出問(wèn)題的時(shí)候都會(huì)有郵件通知到郵件通知接收者。
二、Email Extension Plugin插件配置郵件通知
1、全局配置
同樣在點(diǎn)擊左邊的“系統(tǒng)管理”菜單,選擇右邊的“系統(tǒng)設(shè)置”,找到Extend E-mail Notification進(jìn)行全局配置。
同樣填好SMTP Server的信息。點(diǎn)擊“高級(jí)”進(jìn)行SMTP鑒權(quán)的配置,配置發(fā)郵件人的用戶(hù)名、密碼等信息。
默認(rèn)收件人填需要發(fā)送郵件通知的人,如有多個(gè)用空格分隔
點(diǎn)擊最右下角的"Default Triggers ..."按鈕設(shè)置默認(rèn)的觸發(fā)郵件通知的事件。
根據(jù)實(shí)際情況勾選需要觸發(fā)郵件通知的事件。
保存全局的配置信息后到項(xiàng)目中進(jìn)行項(xiàng)目的配置。
2、項(xiàng)目配置
進(jìn)入到具體的項(xiàng)目配置界面點(diǎn)擊“配置”,在配置界面點(diǎn)擊“增加構(gòu)建后操作步驟”,選擇“Editable Email Notification”
在設(shè)置中保存默認(rèn)就可以了。
可以在“Advanced Settings”中針對(duì)該項(xiàng)目進(jìn)行個(gè)性化的配置。
可以針對(duì)該項(xiàng)目定義該項(xiàng)目通知的收件人列表、主題、內(nèi)容、附件等。
設(shè)置完后點(diǎn)擊保存。就可以去驗(yàn)證是否可以郵件通知了。
通過(guò)測(cè)試工程構(gòu)建后,Jenkins配置的郵件通接收人可以正常收到構(gòu)建信息的郵件通知。
到這里Jenkins配置郵件通知全部完成了。
======================================
郵件通知配置相關(guān)的全局屬性詳解
Override Global Settings:如果不選,該插件將使用默認(rèn)的E-mail Notification通知選項(xiàng)。反之,您可以通過(guò)指定不同于( 默認(rèn)選項(xiàng))的設(shè)置來(lái)進(jìn)行覆蓋。
Default Content Type:指定構(gòu)建后發(fā)送郵件內(nèi)容的類(lèi)型,有Text和HTML兩種.
Use List-ID Email Header:為所有的郵件設(shè)置一個(gè)List-ID的郵件信頭
Add 'Precedence: bulk' Email Header:設(shè)置優(yōu)先級(jí)
Default Recipients:自定義默認(rèn)電子郵件收件人列表。如果沒(méi)有被項(xiàng)目配置覆蓋,該插件會(huì)使用這個(gè)列表。您可以在項(xiàng)目配置使用$ DEFAULT_RECIPIENTS參數(shù)包括此默認(rèn)列表,以及添加新的地址在項(xiàng)目級(jí)別。添加抄送:cc:電子郵件地址例如,CC:someone@somewhere.com
Reply To List:回復(fù)列表, 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.
Emergency reroute:如果這個(gè)字段不為空,所有的電子郵件將被單獨(dú)發(fā)送到該地址(或地址列表)。
Excluded Committers:防止郵件被郵件系統(tǒng)認(rèn)為是垃圾郵件,郵件列表應(yīng)該沒(méi)有擴(kuò)展的賬戶(hù)名(如:@domain.com),并且使用逗號(hào)分隔
Default Subject:自定義郵件通知的默認(rèn)主題名稱(chēng)。該選項(xiàng)能在郵件的主題字段中替換一些參數(shù),這樣你就可以在構(gòu)建中包含指定的輸出信息。
Maximum Attachment Size:郵件最大附件大小。
Default Content:自定義郵件通知的默認(rèn)內(nèi)容主體。該選項(xiàng)能在郵件的內(nèi)容中替換一些參數(shù),這樣你就可以在構(gòu)建中包含指定的輸出信息。
Default Pre-send Script:默認(rèn)發(fā)送前執(zhí)行的腳本(注:grooy腳本,這是我在某篇文章上看到的,不一定準(zhǔn)確)。
Enable Debug Mode:?jiǎn)⒂貌寮恼{(diào)試模式。這將增加額外的日志輸出,構(gòu)建日志以及Jenkins的日志。在調(diào)試時(shí)是有用的,但不能用于生產(chǎn)。
Enable Security:?jiǎn)⒂脮r(shí),會(huì)禁用發(fā)送腳本的能力,直接進(jìn)入Jenkins實(shí)例。如果用戶(hù)試圖訪(fǎng)問(wèn)Jenkins管理對(duì)象實(shí)例,將拋出一個(gè)安全異常。
Content Token Reference:郵件中可以使用的變量,所有的變量都是可選的。
全局郵件變量
email-ext插件允許使用變量來(lái)動(dòng)態(tài)插入數(shù)據(jù)到郵件的主題和內(nèi)容主體中。變量是一個(gè)以$(美元符號(hào))開(kāi)始,并以空格結(jié)束的字符串。當(dāng)一個(gè)郵件觸發(fā)時(shí),主題和內(nèi)容主體字段的所有變量都會(huì)通過(guò)真實(shí)的值動(dòng)態(tài)地替換。同樣,變量中的“值”能包含其它的變量,都將被替換成真實(shí)的內(nèi)容。
比如,項(xiàng)目配置頁(yè)的默認(rèn)主題和內(nèi)容分別對(duì)應(yīng)的是全局配置頁(yè)面的DEFAULT_SUBJECT和DEFAULT_CONTENT,因此它會(huì)自動(dòng)地使用全局的配置。同理,觸發(fā)器中的Subject和Content分別對(duì)應(yīng)的是項(xiàng)目配置頁(yè)面的DEFAULT_SUBJECT和DEFAULT_CONTENT,所以它也會(huì)自動(dòng)地使用項(xiàng)目的配置。由于變量中的“值”能包含其它的變量,所以就能為變量快速地創(chuàng)建不同的切入點(diǎn):全局級(jí)別(所有項(xiàng)目),專(zhuān)屬級(jí)別(單一項(xiàng)目),觸發(fā)器級(jí)別(構(gòu)建結(jié)果)。
如果你要查看所有可用的變量,你可以點(diǎn)擊配置頁(yè)的Content Token Reference的問(wèn)號(hào)獲取詳細(xì)的信息。
所有的變量都是可選的,每個(gè)變量可以如下表示,字符串類(lèi)型使用name=“value”,而布爾型和數(shù)字型使用name=value。如果{和}標(biāo)記里面沒(méi)有變量,則不會(huì)被解析。示例:TOKEN,{TOKEN},{TOKEN,count=100},{ENV,var=”P(pán)ATH”}
提示:用英文逗號(hào)分隔變量的參數(shù)。
常用的屬性如下:
${FILE,path="PATH"} 包括指定文件(路徑)的含量相對(duì)于工作空間根目錄。
path文件路徑,注意:是工作區(qū)目錄的相對(duì)路徑。
${BUILD_NUMBER} 顯示當(dāng)前構(gòu)建的編號(hào)。
${JOB_DESCRIPTION} 顯示項(xiàng)目描述。
${SVN_REVISION} 顯示svn版本號(hào)。還支持Subversion插件出口的SVN_REVISION_n版本。
${CAUSE} 顯示誰(shuí)、通過(guò)什么渠道觸發(fā)這次構(gòu)建。
${CHANGES } -顯示上一次構(gòu)建之后的變化。
showPaths 如果為 true,顯示提交修改后的地址。默認(rèn)false。
showDependencies 如果為true,顯示項(xiàng)目構(gòu)建依賴(lài)。默認(rèn)為false
format 遍歷提交信息,一個(gè)包含%X的字符串,其中%a表示作者,%d表示日期,%m表示消息,%p表示路徑,%r表示版本。注意,并不是所有的版本系統(tǒng)都支持%d和%r。如果指定showPaths將被忽略。默認(rèn)“[%a] %m\n”。
pathFormat 一個(gè)包含“%p”的字符串,用來(lái)標(biāo)示怎么打印路徑。
${BUILD_ID}顯示當(dāng)前構(gòu)建生成的ID。
${PROJECT_NAME} 顯示項(xiàng)目的全名。
${PROJECT_DISPLAY_NAME} 顯示項(xiàng)目的顯示名稱(chēng)。
{SCRIPT} 從一個(gè)腳本生成自定義消息內(nèi)容。自定義腳本應(yīng)該放在"JENKINS_HOME/email-templates"。當(dāng)使用自定義腳本時(shí)會(huì)默認(rèn)搜索$JENKINS_HOME/email-templatesdirectory目錄。其他的目錄將不會(huì)被搜索。
script 當(dāng)其使用的時(shí)候,僅僅只有最后一個(gè)值會(huì)被腳本使用(不能同時(shí)使用script和template)。
template常規(guī)的simpletemplateengine格式模板。
${JENKINS_URL} 顯示Jenkins服務(wù)器的url地址(你可以再系統(tǒng)配置頁(yè)更改)。
${BUILD_LOG_MULTILINE_REGEX}按正則表達(dá)式匹配并顯示構(gòu)建日志。
regex java.util.regex.Pattern 生成正則表達(dá)式匹配的構(gòu)建日志。無(wú)默認(rèn)值,可為空。
maxMatches 匹配的最大數(shù)量。如果為0,將匹配所有。默認(rèn)為0。
showTruncatedLines 如果為true,包含[...truncated ### lines...]行。默認(rèn)為true。
substText 如果非空,就把這部分文字(而不是整行)插入該郵件。默認(rèn)為空。
escapeHtml 如果為true,格式化HTML。默認(rèn)為false。
matchedSegmentHtmlStyle 如果非空,輸出HTML。匹配的行數(shù)將變?yōu)?lt;b style=”your-style-value”> html escaped matched line </b>格式。默認(rèn)為空。
${BUILD_LOG} 顯示最終構(gòu)建日志。
maxLines 日志最多顯示的行數(shù),默認(rèn)250行。
escapeHtml 如果為true,格式化HTML。默認(rèn)false。
${PROJECT_URL} 顯示項(xiàng)目的URL地址。
${BUILD_STATUS} -顯示當(dāng)前構(gòu)建的狀態(tài)(失敗、成功等等)
${BUILD_URL} -顯示當(dāng)前構(gòu)建的URL地址。
${CHANGES_SINCE_LAST_SUCCESS} -顯示上一次成功構(gòu)建之后的變化。
reverse在頂部標(biāo)示新近的構(gòu)建。默認(rèn)false。
format遍歷構(gòu)建信息,一個(gè)包含%X的字符串,其中%c為所有的改變,%n為構(gòu)建編號(hào)。默認(rèn)”Changes for Build #%n\n%c\n”。
showPaths,changesFormat,pathFormat分別定義如${CHANGES}的showPaths、format和pathFormat參數(shù)。
${CHANGES_SINCE_LAST_UNSTABLE} -顯示顯示上一次不穩(wěn)固或者成功的構(gòu)建之后的變化。
reverse在頂部標(biāo)示新近的構(gòu)建。默認(rèn)false
format遍歷構(gòu)建信息,一個(gè)包含%X的字符串,其中%c為所有的改變,%n為構(gòu)建編號(hào)。默認(rèn)”Changes for Build #%n\n%c\n”。
showPaths,changesFormat,pathFormat分別定義如${CHANGES}的showPaths、format和pathFormat參數(shù)。
${ENV} –顯示一個(gè)環(huán)境變量。
var– 顯示該環(huán)境變量的名稱(chēng)。如果為空,顯示所有,默認(rèn)為空。
${FAILED_TESTS} -如果有失敗的測(cè)試,顯示這些失敗的單元測(cè)試信息。
${JENKINS_URL} -顯示Jenkins服務(wù)器的地址。(你能在“系統(tǒng)配置”頁(yè)改變它)。
{HUDSON_URL} -不推薦,請(qǐng)使用JENKINS_URL
${PROJECT_URL} -顯示項(xiàng)目的URL。
${SVN_REVISION} -顯示SVN的版本號(hào)。
{JELLY_SCRIPT} -從一個(gè)Jelly腳本模板中自定義消息內(nèi)容。有兩種模板可供配置:HTML和TEXT。你可以在JENKINS_HOME/email-templates下自定義替換它。當(dāng)使用自動(dòng)義模板時(shí),”template”參數(shù)的名稱(chēng)不包含“.jelly”。
template模板名稱(chēng),默認(rèn)”html”。
${TEST_COUNTS} -顯示測(cè)試的數(shù)量。
var– 默認(rèn)“total”。
total -所有測(cè)試的數(shù)量。
fail -失敗測(cè)試的數(shù)量。
skip -跳過(guò)測(cè)試的數(shù)量。