本文主要對Windows環境 jenkins 的郵件通知進行介紹
- jenkins 內置的郵件功能
- 使用email-ext插件擴展的郵件功能
郵件通知功能主要包含兩個部分:全局配置和項目配置。
一. 先介紹下內置的Jenkins 郵件服務器 配置
1、系統管理-系統設置,先設置發件人的郵件,切記:一定要設置,且在系統管理員那個地方設置的email地址要和email配置的相同
2、系統管理-系統設置,再設置全局設置:
可以勾選 “通過發送測試郵件配置” 測試此配置能否連通, 如果收到以下郵件,恭喜 This is test email #1 sent from Jenkins
3、對構建的job 添加郵件發送的步驟,針對具體job名稱-配置,如下圖:
這樣每次build后都會發送郵件給這個接收者, 到這里你會發現,只能發給 固定的對象,且格式單一(txt)
二、介紹email-ext插件配置
Jenkins默認提供了一個郵件通知,能在構建失敗、構建不穩定等狀態后發送郵件。但是它本身有很多局限性,比如它的郵件通知無法提供詳細的郵件內容、無法定義發送郵件的格式、無法定義靈活的郵件接收配置等等。在這樣的情況下,我們找到了Jenkins Email Extension Plugin。該插件能允許你自定義郵件通知的方方面面,比如在發送郵件時你可以自定義發送給誰,發送具體什么內容等等。
email-ext插件可根據構建的結果,發送構建報告,給當前的committer (用git做代碼管理)
1) 該插件支持jenkins 1.5以上的版本,插件的安裝此處略 ,若您可選插件的頁卡的列表是空的,先去高級頁面檢查更新下。
2)插件用於job配置頁面,添加構建后步驟“Editable Email Notification”
1、系統管理-系統設置,先設置全局:
詳細參數說明如下:
1. Override Global Settings:如果不選,該插件將使用默認的E-mail Notification通知選項。反之,您可以通過指定不同於( 默認選項)的設置來進行覆蓋。 2. Default Content Type:指定構建后發送郵件內容的類型,有Text和HTML兩種. 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> 4. Add 'Precedence: bulk' Email Header:設置優先級, 5. Default Recipients:自定義默認電子郵件收件人列表。如果沒有被項目配置覆蓋,該插件會使用這個列表。您可以在項目配置使用$ DEFAULT_RECIPIENTS參數包括此默認列表,以及添加新的地址在項目級別。添加抄送:cc:電子郵件地址例如,CC:someone@somewhere.com 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. 7. Emergency reroute:如果這個字段不為空,所有的電子郵件將被單獨發送到該地址(或地址列表)。 8. Excluded Committers:防止郵件被郵件系統認為是垃圾郵件,郵件列表應該沒有擴展的賬戶名(如:@domain.com),並且使用逗號分隔 9. Default Subject:自定義郵件通知的默認主題名稱。該選項能在郵件的主題字段中替換一些參數,這樣你就可以在構建中包含指定的輸出信息。 10. Maximum Attachment Size:郵件最大附件大小。 11. Default Content:自定義郵件通知的默認內容主體。該選項能在郵件的內容中替換一些參數,這樣你就可以在構建中包含指定的輸出信息。 12. Default Pre-send Script:默認發送前執行的腳本(注:grooy腳本,這是我在某篇文章上看到的,不一定准確)。 13. Enable Debug Mode:啟用插件的調試模式。這將增加額外的日志輸出,構建日志以及Jenkins的日志。在調試時是有用的,但不能用於生產。 14. Enable Security:啟用時,會禁用發送腳本的能力,直接進入Jenkins實例。如果用戶試圖訪問Jenkins管理對象實例,將拋出一個安全異常。 15. Content Token Reference:郵件中可以使用的變量,所有的變量都是可選的。
2、項目配置
1)要想在一個項目中使用email-ext插件,你首先必須在項目配置頁激活它。在構建后操作——”Add Post-build Actions”選項中勾選”Editable Email Notification”標簽。如下圖:
項目基本配置參數說明:
當插件激活后你就能編輯如下字段(只列出常用的字段): Project Recipient List:這是一個以逗號(或者空格)分隔的收件人郵件的郵箱地址列表。允許您為每封郵件指定單獨的列表。Ps:如果你想在默認收件人的基礎上添加收件人:$DEFAULT_RECIPIENTS,<新的收件人> Default Subject:允許你配置此項目郵件的主題。 Default Content:跟Default Subject的作用一樣,但是是替換郵件內容。 Attach Build Log:附件構建日志。 Compress Build Log before sending:發送前壓縮生成日志(zip格式)。
2)點擊高級,設置觸發器:(注意:所有的觸發器都只能配置一次)
觸發器參數說明:
Failure:即時發送構建失敗的郵件。如果”Still Failing”觸發器已配置,而上一次構建的狀態是”Failure”,那么”Still Failing”觸發器將發送一封郵件來替代(它)。
Unstable:即時發送構建不穩固的郵件。如果”Still Unstable”觸發器已配置,而上一次構建的狀態是”Unstable”,那么”Still Unstable”觸發器將發送一封郵件來替代(它)。
Still Failing:如果兩次或兩次以上連續構建的狀態為”Failure”,發送該郵件。
Success:如果構建的狀態為”Successful”發送郵件。如果”Fixed”已配置,而上次構建的狀態為“Failure”或“Unstable”,那么”Fixed”觸發器將發送一封郵件來替代(它)。
Fixed:當構建狀態從“Failure”或“Unstable”變為”Successful”時發送郵件。
Still Unstable:如果兩次或兩次以上連續構建的狀態為” Unstable “,發送該郵件。
Before Build:當構建開始時發送郵件。
對於內容,你也許注意到了 這里調用了個 ‘html.jelly’ 的模板,這是插件內置的,直接用即可。
當然也可以自己寫 jelly文件, 確保放置 jenkins/home/email-template下 以供jenkins調用。
三、附email-ext郵件通知模板
發現一個很好的郵件通知模板,如下:
Default Subject:
構建通知:${BUILD_STATUS} - ${PROJECT_NAME} - Build # ${BUILD_NUMBER} !
Default Content:
<!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>(本郵件是程序自動下發的,請勿回復!)</td> </tr> <tr> <td><h2> <font color="#0000FF">構建結果 - ${BUILD_STATUS}</font> </h2></td> </tr> <tr> <td><br /> <b><font color="#0B610B">構建信息</font></b> <hr size="2" width="100%" align="center" /></td> </tr> <tr> <td> <ul> <li>項目名稱 : ${PROJECT_NAME}</li> <li>構建編號 : 第${BUILD_NUMBER}次構建</li> <li>SVN 版本: ${SVN_REVISION}</li> <li>觸發原因: ${CAUSE}</li> <li>構建日志: <a href="${BUILD_URL}console">${BUILD_URL}console</a></li> <li>構建 Url : <a href="${BUILD_URL}">${BUILD_URL}</a></li> <li>工作目錄 : <a href="${PROJECT_URL}ws">${PROJECT_URL}ws</a></li> <li>項目 Url : <a href="${PROJECT_URL}">${PROJECT_URL}</a></li> </ul> </td> </tr> <tr> <td><b><font color="#0B610B">Changes Since Last Successful Build:</font></b> <hr size="2" width="100%" align="center" /></td> </tr> <tr> <td> <ul> <li>歷史變更記錄 : <a href="${PROJECT_URL}changes">${PROJECT_URL}changes</a></li> </ul> ${CHANGES_SINCE_LAST_SUCCESS,reverse=true, format="Changes for Build #%n:<br />%c<br />",showPaths=true,changesFormat="<pre>[%a]<br />%m</pre>",pathFormat=" %p"} </td> </tr> <tr> <td><b>Failed Test Results</b> <hr size="2" width="100%" align="center" /></td> </tr> <tr> <td><pre style="font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif">$FAILED_TESTS</pre> <br /></td> </tr> <tr> <td><b><font color="#0B610B">構建日志 (最后 100行):</font></b> <hr size="2" width="100%" align="center" /></td> </tr> <!-- <tr> <td>Test Logs (if test has ran): <a href="${PROJECT_URL}ws/TestResult/archive_logs/Log-Build-${BUILD_NUMBER}.zip">${PROJECT_URL}/ws/TestResult/archive_logs/Log-Build-${BUILD_NUMBER}.zip</a> <br /> <br /> </td> </tr> --> <tr> <td><textarea cols="80" rows="30" readonly="readonly" style="font-family: Courier New">${BUILD_LOG, maxLines=100}</textarea> </td> </tr> </table> </body> </html>