Jenkins配置郵件提醒 - 草稿

內(nè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)的郵件通知葡公,但是它本身有很多局限性,比如它的郵件通知無法提供詳細(xì)的郵件內(nèi)容条霜、無法定義發(fā)送郵件的格式催什、無法定義靈活的郵件接收配置等等。

另外一種是通過安裝Email Extension Plugin插件宰睡,使用該插件來發(fā)送郵件通知蒲凶。

不管哪種郵件通知都有全局配置和項(xiàng)目配置。其中全局配置是在Jenkins中系統(tǒng)管理的系統(tǒng)設(shè)置里面設(shè)置拆内,項(xiàng)目配置在具體的項(xiàng)目中的配置中設(shè)置旋圆。

下面分別說明Jenkins兩種郵件通知的配置。

示例中的Jenkins版本為Jenkins ver. 2.27

一麸恍、Jenkins內(nèi)置默認(rèn)的郵件通知配置

1灵巧、全局配置

image

點(diǎn)擊左邊的“系統(tǒng)管理”菜單,選擇右邊的“系統(tǒng)設(shè)置”

image

在系統(tǒng)設(shè)置中找到Jenkins Locaction項(xiàng)填入Jenkins URL和系統(tǒng)管理員郵件地址抹沪,系統(tǒng)管理員郵件地址一定要配置孩等,否則發(fā)不了郵件通知。因?yàn)猷]件通知都是由系統(tǒng)管理員的郵箱發(fā)出來的采够。

image

找到郵件通知項(xiàng),填入SMTP服務(wù)器信息及用戶名冰垄、密碼等認(rèn)證信息蹬癌。

image

配好以后勾選“通過發(fā)送測(cè)試郵件測(cè)試配置”

image

填入接收測(cè)試郵件的地址,點(diǎn)擊“Test configuration”虹茶。如果配置正確就會(huì)在下面顯示Email was successfully sent

image

在測(cè)試接收郵箱就會(huì)收到由Jenkins系統(tǒng)管理員的郵箱發(fā)出來的一封測(cè)試郵件逝薪。說明郵箱通知確實(shí)已經(jīng)配置正確并能夠正常收發(fā)Jenkins的通知郵件了。有網(wǎng)友說如果配的發(fā)送郵箱是某個(gè)郵件服務(wù)商的比如163的郵件蝴罪,接收郵箱也得要配相同郵件服務(wù)商163的才可以收到郵件董济,經(jīng)過測(cè)試沒有這種限制,只要是能夠收發(fā)郵件隨便配哪個(gè)郵件服務(wù)商126要门、163虏肾、QQ廓啊、189甚至公司郵件等的都可以收。

image

2封豪、項(xiàng)目配置

郵件通知的全局設(shè)置配好以后就可以在具體的項(xiàng)目中應(yīng)用發(fā)送郵件通知了谴轮。

image

在項(xiàng)目的設(shè)置中找到“增加構(gòu)建后的操作步驟”,選擇“E-mail Notifacation”通過E-mail通知吹埠。

image

在Recipients中填入郵件通知接收者中第步,如果有多個(gè)接收者用空格分隔,可以發(fā)送郵件通知給多個(gè)相關(guān)的接收人缘琅。

image

如果配置沒有問題粘都,在構(gòu)建出問題的時(shí)候都會(huì)有郵件通知到郵件通知接收者。

image

二刷袍、Email Extension Plugin插件配置郵件通知

1翩隧、全局配置

同樣在點(diǎn)擊左邊的“系統(tǒng)管理”菜單,選擇右邊的“系統(tǒng)設(shè)置”做个,找到Extend E-mail Notification進(jìn)行全局配置鸽心。

image

同樣填好SMTP Server的信息。點(diǎn)擊“高級(jí)”進(jìn)行SMTP鑒權(quán)的配置居暖,配置發(fā)郵件人的用戶名顽频、密碼等信息。

image

默認(rèn)收件人填需要發(fā)送郵件通知的人太闺,如有多個(gè)用空格分隔

image

點(diǎn)擊最右下角的"Default Triggers ..."按鈕設(shè)置默認(rèn)的觸發(fā)郵件通知的事件糯景。

image

根據(jù)實(shí)際情況勾選需要觸發(fā)郵件通知的事件。

image

保存全局的配置信息后到項(xiàng)目中進(jìn)行項(xiàng)目的配置省骂。

2蟀淮、項(xiàng)目配置

進(jìn)入到具體的項(xiàng)目配置界面點(diǎn)擊“配置”,在配置界面點(diǎn)擊“增加構(gòu)建后操作步驟”钞澳,選擇“Editable Email Notification”

image

在設(shè)置中保存默認(rèn)就可以了怠惶。

image

可以在“Advanced Settings”中針對(duì)該項(xiàng)目進(jìn)行個(gè)性化的配置。

image

可以針對(duì)該項(xiàng)目定義該項(xiàng)目通知的收件人列表轧粟、主題策治、內(nèi)容、附件等兰吟。

image

設(shè)置完后點(diǎn)擊保存通惫。就可以去驗(yàn)證是否可以郵件通知了。

通過測(cè)試工程構(gòu)建后混蔼,Jenkins配置的郵件通接收人可以正常收到構(gòu)建信息的郵件通知履腋。

image

到這里Jenkins配置郵件通知全部完成了。

======================================

郵件通知配置相關(guān)的全局屬性詳解

  1. Override Global Settings:如果不選,該插件將使用默認(rèn)的E-mail Notification通知選項(xiàng)遵湖。反之悔政,您可以通過指定不同于( 默認(rèn)選項(xiàng))的設(shè)置來進(jìn)行覆蓋坦胶。

  2. Default Content Type:指定構(gòu)建后發(fā)送郵件內(nèi)容的類型嘹叫,有Text和HTML兩種.

  3. Use List-ID Email Header:為所有的郵件設(shè)置一個(gè)List-ID的郵件信頭

  4. Add 'Precedence: bulk' Email Header:設(shè)置優(yōu)先級(jí)

  5. Default Recipients:自定義默認(rèn)電子郵件收件人列表。如果沒有被項(xiàng)目配置覆蓋,該插件會(huì)使用這個(gè)列表限书。您可以在項(xiàng)目配置使用$ DEFAULT_RECIPIENTS參數(shù)包括此默認(rèn)列表垄潮,以及添加新的地址在項(xiàng)目級(jí)別烹卒。添加抄送:cc:電子郵件地址例如,CC:someone@somewhere.com

  6. 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.

  7. Emergency reroute:如果這個(gè)字段不為空,所有的電子郵件將被單獨(dú)發(fā)送到該地址(或地址列表)弯洗。

  8. Excluded Committers:防止郵件被郵件系統(tǒng)認(rèn)為是垃圾郵件,郵件列表應(yīng)該沒有擴(kuò)展的賬戶名(如:@domain.com),并且使用逗號(hào)分隔

  9. Default Subject:自定義郵件通知的默認(rèn)主題名稱旅急。該選項(xiàng)能在郵件的主題字段中替換一些參數(shù),這樣你就可以在構(gòu)建中包含指定的輸出信息牡整。

  10. Maximum Attachment Size:郵件最大附件大小藐吮。

  11. Default Content:自定義郵件通知的默認(rèn)內(nèi)容主體。該選項(xiàng)能在郵件的內(nèi)容中替換一些參數(shù)逃贝,這樣你就可以在構(gòu)建中包含指定的輸出信息谣辞。

  12. Default Pre-send Script:默認(rèn)發(fā)送前執(zhí)行的腳本(注:grooy腳本,這是我在某篇文章上看到的沐扳,不一定準(zhǔn)確)泥从。

  13. Enable Debug Mode:?jiǎn)⒂貌寮恼{(diào)試模式。這將增加額外的日志輸出沪摄,構(gòu)建日志以及Jenkins的日志躯嫉。在調(diào)試時(shí)是有用的,但不能用于生產(chǎn)杨拐。

  14. Enable Security:?jiǎn)⒂脮r(shí)祈餐,會(huì)禁用發(fā)送腳本的能力,直接進(jìn)入Jenkins實(shí)例哄陶。如果用戶試圖訪問Jenkins管理對(duì)象實(shí)例帆阳,將拋出一個(gè)安全異常。

  15. Content Token Reference:郵件中可以使用的變量屋吨,所有的變量都是可選的舱痘。

全局郵件變量

email-ext插件允許使用變量來動(dòng)態(tài)插入數(shù)據(jù)到郵件的主題和內(nèi)容主體中。變量是一個(gè)以$(美元符號(hào))開始离赫,并以空格結(jié)束的字符串。當(dāng)一個(gè)郵件觸發(fā)時(shí)塌碌,主題和內(nèi)容主體字段的所有變量都會(huì)通過真實(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)目),專屬級(jí)別(單一項(xiàng)目)遗座,觸發(fā)器級(jí)別(構(gòu)建結(jié)果)舀凛。

如果你要查看所有可用的變量,你可以點(diǎn)擊配置頁(yè)的Content Token Reference的問號(hào)獲取詳細(xì)的信息途蒋。

所有的變量都是可選的猛遍,每個(gè)變量可以如下表示,字符串類型使用name=“value”号坡,而布爾型和數(shù)字型使用name=value懊烤。如果{和}標(biāo)記里面沒有變量,則不會(huì)被解析宽堆。示例:TOKEN,{TOKEN},{TOKEN,count=100},{ENV,var=”PATH”}

提示:用英文逗號(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í)嗡综、通過什么渠道觸發(fā)這次構(gòu)建乙帮。

${CHANGES } -顯示上一次構(gòu)建之后的變化。

showPaths 如果為 true,顯示提交修改后的地址极景。默認(rèn)false察净。

showDependencies 如果為true,顯示項(xiàng)目構(gòu)建依賴盼樟。默認(rèn)為false

format 遍歷提交信息氢卡,一個(gè)包含%X的字符串,其中%a表示作者晨缴,%d表示日期译秦,%m表示消息,%p表示路徑,%r表示版本筑悴。注意们拙,并不是所有的版本系統(tǒng)都支持%d和%r。如果指定showPaths將被忽略阁吝。默認(rèn)“[%a] %m\n”砚婆。

pathFormat 一個(gè)包含“%p”的字符串,用來標(biāo)示怎么打印路徑突勇。

${BUILD_ID}顯示當(dāng)前構(gòu)建生成的ID装盯。

${PROJECT_NAME} 顯示項(xiàng)目的全名。

${PROJECT_DISPLAY_NAME} 顯示項(xià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)建日志借宵。無默認(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)境變量的名稱。如果為空设拟,顯示所有慨仿,默認(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ù)的名稱不包含“.jelly”综苔。

template模板名稱,默認(rèn)”html”位岔。

${TEST_COUNTS} -顯示測(cè)試的數(shù)量如筛。

var– 默認(rèn)“total”。

total -所有測(cè)試的數(shù)量抒抬。

fail -失敗測(cè)試的數(shù)量杨刨。

skip -跳過測(cè)試的數(shù)量。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末擦剑,一起剝皮案震驚了整個(gè)濱河市妖胀,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌抓于,老刑警劉巖做粤,帶你破解...
    沈念sama閱讀 206,378評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異捉撮,居然都是意外死亡怕品,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,356評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門巾遭,熙熙樓的掌柜王于貴愁眉苦臉地迎上來肉康,“玉大人,你說我怎么就攤上這事灼舍『鸷停” “怎么了?”我有些...
    開封第一講書人閱讀 152,702評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵骑素,是天一觀的道長(zhǎng)炫乓。 經(jīng)常有香客問我,道長(zhǎng)献丑,這世上最難降的妖魔是什么末捣? 我笑而不...
    開封第一講書人閱讀 55,259評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮创橄,結(jié)果婚禮上箩做,老公的妹妹穿的比我還像新娘。我一直安慰自己妥畏,他們只是感情好邦邦,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,263評(píng)論 5 371
  • 文/花漫 我一把揭開白布安吁。 她就那樣靜靜地躺著,像睡著了一般燃辖。 火紅的嫁衣襯著肌膚如雪鬼店。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,036評(píng)論 1 285
  • 那天黔龟,我揣著相機(jī)與錄音薪韩,去河邊找鬼。 笑死捌锭,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的罗捎。 我是一名探鬼主播观谦,決...
    沈念sama閱讀 38,349評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼桨菜!你這毒婦竟也來了豁状?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,979評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤倒得,失蹤者是張志新(化名)和其女友劉穎泻红,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體霞掺,經(jīng)...
    沈念sama閱讀 43,469評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡谊路,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,938評(píng)論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了菩彬。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片缠劝。...
    茶點(diǎn)故事閱讀 38,059評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖骗灶,靈堂內(nèi)的尸體忽然破棺而出惨恭,到底是詐尸還是另有隱情,我是刑警寧澤耙旦,帶...
    沈念sama閱讀 33,703評(píng)論 4 323
  • 正文 年R本政府宣布脱羡,位于F島的核電站,受9級(jí)特大地震影響免都,放射性物質(zhì)發(fā)生泄漏锉罐。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,257評(píng)論 3 307
  • 文/蒙蒙 一琴昆、第九天 我趴在偏房一處隱蔽的房頂上張望氓鄙。 院中可真熱鬧,春花似錦业舍、人聲如沸抖拦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,262評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)态罪。三九已至噩茄,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間复颈,已是汗流浹背绩聘。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留耗啦,地道東北人凿菩。 一個(gè)月前我還...
    沈念sama閱讀 45,501評(píng)論 2 354
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像帜讲,于是被迫代替她去往敵國(guó)和親衅谷。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,792評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容