寫的不錯一定要看 ———————— Jenkins學習四：Jenkins 郵件配置
阿新 • • 發佈：2019-02-19
本文主要對Windows環境 jenkins 的郵件通知進行介紹
- jenkins 內建的郵件功能
- 使用email-ext外掛擴充套件的郵件功能
郵件通知功能主要包含兩個部分：全域性配置和專案配置。
一. 先介紹下內建的Jenkins 郵件伺服器 配置
1、系統管理－系統設定，先設定發件人的郵件，切記：一定要設定，且在系統管理員那個地方設定的email地址要和email配置的相同
2、系統管理－系統設定，再設定全域性設定：
可以勾選 “通過傳送測試郵件配置” 測試此配置能否連通， 如果收到以下郵件，恭喜 This is test email #1 sent from Jenkins
3、對構建的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:[email protected] 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>