如何找到“BB”之人？（Break Build)

作者：悟空聊架構(gòu) 2024-06-13 08:51:14

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

你好，我是悟空。

圖片

一、前言

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

圖片

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

你是否遇到過自己提交了的代碼，導(dǎo)致整個項目的代碼編譯失敗？
你是否因為編譯失敗而被郵件通報？
你是否因為被郵件通報而被罰money？

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

他們因為將未經(jīng)本地編譯通過的代碼直接往代碼倉庫提交，導(dǎo)致服務(wù)器編譯打包部署時，直接報錯，而耽誤了整個測試進(jìn)度。

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

二、Break Build 是什么？

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

2.1 定義

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

2.2 常見原因

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

2.3 影響

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

2.4 處理方法

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

三、如何找到 Break Build 之人

3.1 通知邏輯

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

圖片