你好，我是悟空。

圖片

一、前言

我們先來(lái)看一封 Break Build（BB） 郵件，如下圖所示，這封郵件清楚的展示誰(shuí) BB 了，以及如何 BB 的。

圖片

今天我們要聊的話題是在自動(dòng)化部署的過(guò)程中，如何找到造成本次部署失敗的人。而在持續(xù)集成領(lǐng)域，部署失敗被稱作 Break Build，簡(jiǎn)稱 BB。

你是否遇到過(guò)自己提交了的代碼，導(dǎo)致整個(gè)項(xiàng)目的代碼編譯失??？

你是否因?yàn)榫幾g失敗而被郵件通報(bào)？

你是否因?yàn)楸秽]件通報(bào)而被罰money？

這些都是我們之前項(xiàng)目組里面開發(fā)同學(xué)親身經(jīng)歷。

他們因?yàn)閷⑽唇?jīng)本地編譯通過(guò)的代碼直接往代碼倉(cāng)庫(kù)提交，導(dǎo)致服務(wù)器編譯打包部署時(shí)，直接報(bào)錯(cuò)，而耽誤了整個(gè)測(cè)試進(jìn)度。

然后這些開發(fā)同學(xué)就會(huì)收到一封 “BB” 郵件，凡是收到這封郵件的人，所在的小組會(huì)被記一筆小黑賬，后續(xù)需上交一點(diǎn)點(diǎn) money~

二、Break Build 是什么？

“Break build”是一個(gè)軟件開發(fā)和持續(xù)集成（CI）領(lǐng)域的術(shù)語(yǔ)，通常指的是在構(gòu)建軟件的過(guò)程中遇到的失敗或錯(cuò)誤，導(dǎo)致整個(gè)構(gòu)建過(guò)程無(wú)法完成。它提醒開發(fā)團(tuán)隊(duì)存在問(wèn)題需要修復(fù)，確保只有穩(wěn)定且無(wú)錯(cuò)誤的代碼才能進(jìn)入后續(xù)階段或部署到生產(chǎn)環(huán)境。

2.1 定義

構(gòu)建過(guò)程包括從編譯源代碼、運(yùn)行測(cè)試到打包成可部署的應(yīng)用程序。當(dāng)這個(gè)過(guò)程中的某一步失敗時(shí)，我們稱之為“break build”。

2.2 常見(jiàn)原因

• 代碼錯(cuò)誤：如語(yǔ)法錯(cuò)誤、編譯錯(cuò)誤或邏輯錯(cuò)誤。
• 測(cè)試失?。?jiǎn)卧獪y(cè)試、集成測(cè)試或端到端測(cè)試未通過(guò)。
• 依賴問(wèn)題：缺少必要的庫(kù)或版本沖突。
• 配置錯(cuò)誤：構(gòu)建腳本或配置文件中的錯(cuò)誤。
• 環(huán)境問(wèn)題：構(gòu)建環(huán)境中的配置或資源問(wèn)題，例如磁盤空間不足或網(wǎng)絡(luò)問(wèn)題。

2.3 影響

• 開發(fā)效率：開發(fā)人員需要花時(shí)間查找和修復(fù)錯(cuò)誤，可能會(huì)延遲項(xiàng)目進(jìn)度。
• 團(tuán)隊(duì)協(xié)作：其他開發(fā)人員可能無(wú)法在代碼庫(kù)的最新版本上繼續(xù)工作，直到構(gòu)建問(wèn)題解決。
• 質(zhì)量保障：未能通過(guò)構(gòu)建的代碼不能部署到生產(chǎn)環(huán)境，確保了只有通過(guò)所有測(cè)試的代碼才會(huì)被發(fā)布。

2.4 處理方法

• 快速反饋：通過(guò)持續(xù)集成工具（如 Jenkins、GitLab CI、Travis CI 等）提供即時(shí)反饋，幫助開發(fā)人員迅速發(fā)現(xiàn)和解決問(wèn)題。
• 自動(dòng)化測(cè)試：在構(gòu)建過(guò)程中自動(dòng)運(yùn)行各種測(cè)試，確保代碼的正確性和穩(wěn)定性。
• 代碼審查和靜態(tài)分析：在提交代碼前進(jìn)行代碼審查和使用靜態(tài)分析工具，減少引入錯(cuò)誤的機(jī)會(huì)。
• 分階段構(gòu)建：將構(gòu)建過(guò)程分成多個(gè)階段（編譯、測(cè)試、打包等），可以更快地定位和解決問(wèn)題。

三、如何找到 Break Build 之人

3.1 通知邏輯

我們可以編寫 Jenkins 的 Pipeline 腳本，如果此次打包失敗了，則找出此次構(gòu)建中的提交記錄，并將代碼提交者、提交注釋、受影響的文件列表及提交時(shí)間都打印出來(lái)，并通過(guò)郵件形式發(fā)送給觸發(fā)構(gòu)建者以及提交代碼的同學(xué)。如果打包成功了，則發(fā)送郵件給觸發(fā)構(gòu)建者。流程如下所示：

圖片

對(duì)應(yīng)的 pipeline 腳本如下圖所示：

圖片

3.2 找出代碼提交者

思路：遍歷當(dāng)前構(gòu)建及其之前的構(gòu)建成功之間構(gòu)建記錄，然后收集每個(gè)構(gòu)建中的提交者信息，最后發(fā)郵件給提交者。

流程如下圖所示：

圖片

這里有個(gè)地方非常拗口：遍歷當(dāng)前構(gòu)建及其之前的構(gòu)建成功之間構(gòu)建記錄，怎么理解呢？

如下圖所示，構(gòu)建記錄 #53 是成功的，那么本次要遍歷的構(gòu)建記錄就是 #54~#58 這幾條記錄。

為什么不是直接找本次構(gòu)建中的代碼提交提交記錄呢？原因是上一次構(gòu)建后，下一次就拿不到提交記錄了，

圖片

對(duì)應(yīng)的 pipeline 腳本如下圖所示：

圖片

四、執(zhí)行結(jié)果

執(zhí)行構(gòu)建后，可以看到本次構(gòu)建中，有兩次代碼提交，有兩個(gè)提交者，可能為同一個(gè)人。那么這兩個(gè)提交者都會(huì)收到 Break Build 郵件，至于是誰(shuí)最終造成的，得看部署日志了。

4.1 打印提交記錄

圖片

對(duì)應(yīng)的失敗通知的郵件模板中打印提交記錄的 html 如下所示：

圖片

4.2 打印詳細(xì)的提交記錄

在失敗通知郵件中還會(huì)打印構(gòu)建日志，如下圖所示：

圖片

對(duì)應(yīng)的失敗通知郵件模板中的打印構(gòu)建日志的 html 如下所示：

圖片

4.3 查看完整的構(gòu)建日志

從郵件中還是無(wú)法確認(rèn)是誰(shuí)提交的代碼造成的問(wèn)題，這個(gè)時(shí)候可以看下構(gòu)建日志。

如下圖所示，可以看到具體哪個(gè)地方報(bào)錯(cuò)了，然后找下誰(shuí)改的這個(gè)文件以及代碼行就能知道是誰(shuí)造成編譯失敗了。

郵件模板

五、總結(jié)

在自動(dòng)化部署過(guò)程中，找到導(dǎo)致構(gòu)建失敗的提交者至關(guān)重要。

構(gòu)建失?。˙reak Build，簡(jiǎn)稱BB）通常由于代碼錯(cuò)誤、測(cè)試失敗、依賴問(wèn)題等原因引起，影響開發(fā)效率和團(tuán)隊(duì)協(xié)作。

我們可以通過(guò)編寫 Jenkins Pipeline 腳本，在構(gòu)建失敗時(shí)遍歷當(dāng)前構(gòu)建及其之前的構(gòu)建記錄，收集每個(gè)構(gòu)建中的提交者信息，并將這些信息通過(guò)郵件發(fā)送給相關(guān)人員。這不僅能迅速通知提交者修復(fù)問(wèn)題，還能確保代碼的穩(wěn)定性和質(zhì)量。

通過(guò)持續(xù)集成工具的快速反饋和自動(dòng)化測(cè)試，我們能夠有效地預(yù)防和處理 Break Build，提高整體開發(fā)效率。