消息通知
本文主要介紹流水線消息通知插件,主要用于流水線運(yùn)行過(guò)程中消息通知、三方系統(tǒng)Webhook觸發(fā)調(diào)用等。
進(jìn)入流水線編輯頁(yè),添加任務(wù),添加插件,支持添加釘釘機(jī)器人通知、郵件通知、Webhook通知、企業(yè)微信機(jī)器人通知、飛書(shū)機(jī)器人通知多種插件。
釘釘機(jī)器人通知
前提條件:已有釘釘群,釘釘群已配置 Webhook 機(jī)器人(機(jī)器人配置參考)。
配置流水線任務(wù)通知插件:復(fù)制機(jī)器人 Webhook 地址,并配置到流水線釘釘通知插件中。
復(fù)制填寫(xiě)釘釘機(jī)器人 webhook 地址。
若釘釘機(jī)器人開(kāi)啟了“加簽”,復(fù)制填寫(xiě)加簽秘鑰。
選擇運(yùn)行狀態(tài),當(dāng)該流水線的任務(wù)進(jìn)入選擇狀態(tài)后,會(huì)觸發(fā)消息通知。
選擇通知內(nèi)容,所選的通知內(nèi)容會(huì)自動(dòng)添加至推送消息中。
支持填寫(xiě)自定義內(nèi)容,支持引用環(huán)境變量,如${CI_COMMIT_TITLE},支持釘釘Markdown語(yǔ)法,查看幫助
支持@手機(jī)號(hào),多個(gè)手機(jī)號(hào)(釘釘手機(jī)號(hào))之間以
,
分隔,支持@all(輸入all即可)。
觸發(fā)流水線運(yùn)行,當(dāng)流水線任務(wù)進(jìn)入通知插件配置的運(yùn)行狀態(tài)時(shí),觸發(fā)消息通知,相應(yīng)釘釘群即可收到消息通知。
郵件通知
配置流水線任務(wù)通知插件:編輯流水線的任務(wù),在任務(wù)插件中選擇郵件通知插件,并填寫(xiě)郵件地址并選擇運(yùn)行時(shí)機(jī)。
觸發(fā)流水線運(yùn)行,當(dāng)流水線任務(wù)進(jìn)入通知插件配置的運(yùn)行狀態(tài)時(shí),收到通知郵件。
Webhook通知
前提條件:Webhook 地址必須公網(wǎng)可訪問(wèn)。
配置流水線任務(wù)通知插件:編輯流水線的任務(wù),在任務(wù)插件中選擇 Webhook 通知,并填寫(xiě) Webhook 地址并選擇運(yùn)行時(shí)機(jī)。
觸發(fā)流水線運(yùn)行,當(dāng)流水線任務(wù)進(jìn)入通知插件配置的運(yùn)行狀態(tài)時(shí),發(fā)起 Webhook 調(diào)用,F(xiàn)low發(fā)送的 Webhook 一律為 Post 請(qǐng)求,任務(wù)狀態(tài)信息的 Payload 示例如下。
{ "event": 'task', "action": 'status', "task": { "pipelineId": 183, "pipelineName": 'test pipeline', "stageName": '構(gòu)建', "taskName": 'java構(gòu)建', "buildNumber": 19, "statusCode": 'SUCCESS', // UNKOWN, RUNNING, WAITING, CANCELLING, CANCELED,FINISH,SUCCESS,FAIL,SKIP "statusName": '運(yùn)行成功', "pipelineUrl": 'https://rdc.aliyun.com/ec/pipelines/156539?build=19', "message": '[test pipeline]流水線階段[構(gòu)建]任務(wù)[java構(gòu)建]運(yùn)行成功' }, "sources": [ { "repo": 'git@gitlab:test.git', "branch": 'master', "commitId": 'xdfdfdff', "privousCommitId": 'ddddd', } ], "globalParams": [ {"key": 'test', "value": 'test1'}, {"key": 'test2', "value": 'test2'} ] }
企業(yè)微信機(jī)器人通知
前提條件:已有微信群,微信群已配置 Webhook 機(jī)器人。
配置流水線任務(wù)通知插件:復(fù)制 Webhook 地址,并配置到流水線企業(yè)微信機(jī)器人通知插件中。
復(fù)制填寫(xiě)企業(yè)微信機(jī)器人 Webhook 地址。
選擇運(yùn)行狀態(tài),當(dāng)該流水線的任務(wù)進(jìn)入選擇狀態(tài)后,會(huì)觸發(fā)消息通知。
選擇通知內(nèi)容,所選的通知內(nèi)容會(huì)自動(dòng)添加至推送消息中。
支持填寫(xiě)自定義內(nèi)容,支持引用環(huán)境變量,如${CI_COMMIT_TITLE},支持釘釘Markdown語(yǔ)法,查看幫助
支持@user_id,多個(gè)手機(jī)號(hào)(企業(yè)微信 user_id)之間以
,
分隔,支持@all(輸入all即可)。可以通過(guò)企業(yè)微信管理后臺(tái) -> 通訊錄獲取用戶 user_id
觸發(fā)流水線運(yùn)行,當(dāng)流水線任務(wù)進(jìn)入通知插件配置的運(yùn)行狀態(tài)時(shí),觸發(fā)消息通知,相應(yīng)微信群即可收到消息通知。
飛書(shū)機(jī)器人通知
前提條件:已有飛書(shū)群,飛書(shū)群已配置 Webhook 機(jī)器人(機(jī)器人配置參考)。
配置流水線任務(wù)通知插件:復(fù)制 Webhook 地址,并配置到流水線飛書(shū)機(jī)器人通知插件中。
復(fù)制填寫(xiě)飛書(shū)機(jī)器人 Webhook 地址。
若飛書(shū)機(jī)器人開(kāi)啟了“加簽”,復(fù)制填寫(xiě)加簽秘鑰。
選擇運(yùn)行狀態(tài),當(dāng)該流水線的任務(wù)進(jìn)入選擇狀態(tài)后,會(huì)觸發(fā)消息通知。
選擇通知內(nèi)容,所選的通知內(nèi)容會(huì)自動(dòng)添加至推送消息中。
支持填寫(xiě)自定義內(nèi)容,支持引用環(huán)境變量,如${CI_COMMIT_TITLE}。
支持@user_id,多個(gè)user_id(飛書(shū)user_id)之間以
,
分隔,支持@all(輸入all即可)。可以通過(guò)飛書(shū)管理后臺(tái) -> 成員與部門(mén)獲取用戶 user_id。
觸發(fā)流水線運(yùn)行,當(dāng)流水線任務(wù)進(jìn)入通知插件配置的運(yùn)行狀態(tài)時(shí),觸發(fā)消息通知,相應(yīng)飛書(shū)群即可收到消息通知。