Jenkins學習之——(4)Email Extension Plugin插件的配置與使用


1.先安裝插件

2.配置

點擊高級后

內容配置:

3.項目配置

點擊Advanced Settings后

到此所有的配置都設置完成。

 

附錄:

以下內容來自其他網友的博客,內容也沒有自己去試,朋友們可以自己去試一下。同時也感謝提供以下信息的網友。

Default Subject:構建通知:$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!

Default Content:

<hr/>

(本郵件是程序自動下發的,請勿回復!)<br/><hr/>

項目名稱:$PROJECT_NAME<br/><hr/>

構建編號:$BUILD_NUMBER<br/><hr/>

svn版本號:${SVN_REVISION}<br/><hr/>

構建狀態:$BUILD_STATUS<br/><hr/>

觸發原因:${CAUSE}<br/><hr/>

構建日志地址:<a href="${BUILD_URL}console">${BUILD_URL}console</a><br/><hr/>

構建地址:<a href="$BUILD_URL">$BUILD_URL</a><br/><hr/>

變更集:${JELLY_SCRIPT,template="html"}<br/><hr/>

下面解釋一下常用的屬性。

全局屬性詳解
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>
關於更詳細的List-ID說明請參閱RFC-2919.

4. Add 'Precedence: bulk' Email Header:設置優先級,更詳細說明請參閱RFC-3834.

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:郵件中可以使用的變量,所有的變量都是可選的。具體介紹請查看全局郵件變量章節。

全局郵件變量

email-ext插件允許使用變量來動態插入數據到郵件的主題和內容主體中。變量是一個以$(美元符號)開始,並以空格結束的字符串。當一個郵件觸發時,主題和內容主體字段的所有變量都會通過真實的值動態地替換。同樣,變量中的“值”能包含其它的變量,都將被替換成真實的內容。

比如,項目配置頁的默認主題和內容分別對應的是全局配置頁面的DEFAULT_SUBJECT和DEFAULT_CONTENT,因此它會自動地使用全局的配置。同理,觸發器中的Subject和Content分別對應的是項目配置頁面的DEFAULT_SUBJECT和DEFAULT_CONTENT,所以它也會自動地使用項目的配置。由於變量中的“值”能包含其它的變量,所以就能為變量快速地創建不同的切入點:全局級別(所有項目),專屬級別(單一項目),觸發器級別(構建結果)。

如果你要查看所有可用的變量,你可以點擊配置頁的Content Token Reference的問號獲取詳細的信息。

所有的變量都是可選的,每個變量可以如下表示,字符串類型使用name=“value”,而布爾型和數字型使用name=value。如果{和}標記里面沒有變量,則不會被解析。示例:$TOKEN,${TOKEN},${TOKEN,count=100},${ENV,var=”PATH”}

提示:用英文逗號分隔變量的參數。

下面我解釋一下常用的屬性。

 ${FILE,path="PATH"} 包括指定文件(路徑)的含量相對於工作空間根目錄。
path文件路徑,注意:是工作區目錄的相對路徑。
 ${BUILD_NUMBER} 顯示當前構建的編號。
 ${JOB_DESCRIPTION} 顯示項目描述。
 ${SVN_REVISION} 顯示svn版本號。還支持Subversion插件出口的SVN_REVISION_n版本。
 ${CAUSE} 顯示誰、通過什么渠道觸發這次構建。
 ${CHANGES } -顯示上一次構建之后的變化。
showPaths 如果為 true,顯示提交修改后的地址。默認false。
showDependencies 如果為true,顯示項目構建依賴。默認為false
format 遍歷提交信息,一個包含%X的字符串,其中%a表示作者,%d表示日期,%m表示消息,%p表示路徑,%r表示版本。注意,並不是所有的版本系統都支持%d和%r。如果指定showPaths將被忽略。默認“[%a] %m\\n”。
pathFormat 一個包含“%p”的字符串,用來標示怎么打印路徑。
 ${BUILD_ID}顯示當前構建生成的ID。
 ${PROJECT_NAME} 顯示項目的全名。(見AbstractProject.getFullDisplayName)
 ${PROJECT_DISPLAY_NAME} 顯示項目的顯示名稱。(見AbstractProject.getDisplayName)
 ${SCRIPT} 從一個腳本生成自定義消息內容。自定義腳本應該放在"$JENKINS_HOME/email-templates"。當使用自定義腳本時會默認搜索$JENKINS_HOME/email-templatesdirectory目錄。其他的目錄將不會被搜索。
 script 當其使用的時候,僅僅只有最后一個值會被腳本使用(不能同時使用script和template)。
 template常規的simpletemplateengine格式模板。
 ${JENKINS_URL} 顯示Jenkins服務器的url地址(你可以再系統配置頁更改)。
 ${BUILD_LOG_MULTILINE_REGEX}按正則表達式匹配並顯示構建日志。
 regex java.util.regex.Pattern 生成正則表達式匹配的構建日志。無默認值,可為空。
 maxMatches 匹配的最大數量。如果為0,將匹配所有。默認為0。
 showTruncatedLines 如果為true,包含[...truncated ### lines...]行。默認為true。
 substText 如果非空,就把這部分文字(而不是整行)插入該郵件。默認為空。
escapeHtml 如果為true,格式化HTML。默認為false。
 matchedSegmentHtmlStyle 如果非空,輸出HTML。匹配的行數將變為<b style=”your-style-value”> html escaped matched line </b>格式。默認為空。
 ${BUILD_LOG} 顯示最終構建日志。
 maxLines 日志最多顯示的行數,默認250行。
 escapeHtml 如果為true,格式化HTML。默認false。
 ${PROJECT_URL} 顯示項目的URL地址。
 ${BUILD_STATUS} -顯示當前構建的狀態(失敗、成功等等)
 ${BUILD_URL} -顯示當前構建的URL地址。
 ${CHANGES_SINCE_LAST_SUCCESS} -顯示上一次成功構建之后的變化。
 reverse在頂部標示新近的構建。默認false。
 format遍歷構建信息,一個包含%X的字符串,其中%c為所有的改變,%n為構建編號。默認”Changes for Build #%n\n%c\n”。
 showPaths,changesFormat,pathFormat分別定義如${CHANGES}的showPaths、format和pathFormat參數。
 ${CHANGES_SINCE_LAST_UNSTABLE} -顯示顯示上一次不穩固或者成功的構建之后的變化。
reverse在頂部標示新近的構建。默認false。
 format遍歷構建信息,一個包含%X的字符串,其中%c為所有的改變,%n為構建編號。默認”Changes for Build #%n\n%c\n”。
 showPaths,changesFormat,pathFormat分別定義如${CHANGES}的showPaths、format和pathFormat參數。
 ${ENV} –顯示一個環境變量。
 var– 顯示該環境變量的名稱。如果為空,顯示所有,默認為空。
 ${FAILED_TESTS} -如果有失敗的測試,顯示這些失敗的單元測試信息。
 ${JENKINS_URL} -顯示Jenkins服務器的地址。(你能在“系統配置”頁改變它)。
 ${HUDSON_URL} -不推薦,請使用$JENKINS_URL
 ${PROJECT_URL} -顯示項目的URL。
 ${SVN_REVISION} -顯示SVN的版本號。
 ${JELLY_SCRIPT} -從一個Jelly腳本模板中自定義消息內容。有兩種模板可供配置:HTML和TEXT。你可以在$JENKINS_HOME/email-templates下自定義替換它。當使用自動義模板時,”template”參數的名稱不包含“.jelly”。
 template模板名稱,默認”html”。
 ${TEST_COUNTS} -顯示測試的數量。
var– 默認“total”。
total -所有測試的數量。
 fail -失敗測試的數量。
 skip -跳過測試的數量。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM