使用AI(ChatGPT)對PR進行自動化 Code Reivew

作者： -

圖片

趁著假日，今天來談談『使用AI(ChatGPT)對PR進行code reivew』這個話題。

這次我們談的code review，是指…
開發人員針對feature branch要merge回主線(master)前，所發出的PR(Pull-Request)，在該PR中，常常會指定團隊中特定的資深開發人員(或Leader)，針對修改的部分(就是PR所關聯的change內容，也就是feature branch中的commit)所進行的code review。

過去，這一段基本都採人工在送出PR之後進行的，請看底下這個GitHub Flow的圖：
圖片
一般來說，這個code review動作發生在上面框出的這一段。

後面那隻松鼠是什麼呢?
這邊是指PR-CI，也就是PR所觸發的CI Pipeline，一般而言，我們會在這個Pipeline當中，針對差異部分(這次PR修改的部分)做靜態程式碼掃描(code analysis)、單元測試(UT)…等動作，這個動作和上面框出的code review，往往會同步(甚至提前)進行。

如此一來，人工code reivew的時候，如果發現PR-CI的build沒過(或是UT沒過)，那根本不用繼續 review 了，直接退回重改即可。

而現在我想談的『使用AI(ChatGPT)對PR進行code reivew』這個部分，就是採用ChatGPT(嚴格來說是Azure Open AI API)對於PR中差異部分的(這次PR修改的部分)進行自動化code review。

如何觸發自動化code review

由於ChatGPT的出現，我們可以透過AI對程式碼進行code review，而在Azure DevOps當中，只需要加入一個套件即可，該套件位於:
https://marketplace.visualstudio.com/items?itemName=tw-developer.GPTPRReviewer
圖片

是一個免費套件。(但當然你OpenAI API呼叫多了是要錢的)

自動化code review，主要是針對PR中修改的部分，而非所有的程式碼，這很合理，否則每次CI Pipeline就會跑亂久了。針對差異掃描，並且頻繁簽入，才是正解。

也因此，你必須先具備底下條件:

  1. 設計一個在PR進行時，會被觸發的Pipeline，一般我們稱為PR CI或PR Pipeline。
  2. 在上述Pipeline中加入前述task，並進行設定。
  3. 針對主線(或特定分支)開一個分支，進行一些修改(change, commit, push)，建立PR單，準備合併到主線(或特定分支)。

好，有了概念之後，我們在來看如何實現。

如何實現自動化code review

首先，我們必須設計一個PR CI Pipeline，我們後面的展示採用的是 asp.net 6 的範例程式碼，因此，這條Pipeline基本上就是一個很標準的 asp.net core 的建置範本。唯一的差別是，加上了一個 GPT PR Reviewer的task(這個task名稱為『Review PR by GPT』，在你安裝了套件之後就可以找到)：
圖片

上圖中有幾個地方需要注意，套件可以採用原生的OpenAI API或是Azure上的OpenAI API，兩者的key有所不同，此外，你也必須在上圖B的部分，選擇是兩者中的哪一個。而如果你選擇的是Azure上的OpenAI API，則還必須填寫上圖C的部分，該endpoint會跟你建立出的Azure OpenAI API端點與模型名稱有所關連，你必須用你的端點和模型名稱替代。

請注意，目前該套件僅支援 GPT 3.5 turbo 這套模型，因此你必須在 Azure OpenAI API上佈署GPT 3.5 turbo 這套模型

最後，D的部分選擇中文即可。這會讓AI當你自動寫的comment出現中文。(否則是英文)

Pipeline 設計好之後，你必須把該 Pipeline 配置成PR觸發，也就是，有任何PR準備合併回主線(master)時，觸發該Pipeline，這一個部份我們先前的文章有介紹過，請參考:
Azure DevOps in Action - 實現PR觸發的CI自動化建置

好了，這樣已經滿足了前面說到的1-3的條件中的1,2，接著，只剩下實際開一個PR試試看了。

但別急，這個套件還有一些設定必須做。

主要是，為了讓套件能夠針對PR單寫入comment，你必須針對repo設定build service的contribute to pr權限。作法如下：

此外，你還必須針對Pipeline的agent job設定 “Allow scripts to access the OAuth token”:

上述兩個動作都是為了讓 pipeline(build service)有權限對PR寫入comment。

好囉，大功告成。

嘗試運行PR

接著，我們針對master建立分支，針對分支上的程式碼進行修改，改完之後建立PR單準備合併回主線(記得PR單上你要選擇reviewer，才能看到AI自動加入的comment)，你會發現，AI(ChatGPT)真的在PR-CI Pipeline中，掃描了所有差異，並且自動把core review結果加入comment:

從上面的影片中你可以看到，GPT給的Comment不算太差，比起 code analysis 工具來說算是有過之而無不及，這一個自動化 code review，可以在人工進行前，針對通用的情境給一個baseline，大幅減少code review的時間成本，也能讓個開發流程的自動化比例更為提高，讓人工可以專注在更有價值的事情上。

後記:
把這篇文章丟給 ChatGPT 去檢查錯字，ChatGPT居然說 : 『「自動化code review」這個詞語有誤，正確應為「自動化程式碼檢查」或「自動化程式碼分析」，因為該文章中提到的 ChatGPT 只能針對程式碼做出建議和意見，並不能真正取代人工的 Code Review。另外，該文章中圖片中的「reivew」也有拼字錯誤，正確應為「review」。』很好，AI你說的對，我錯。但我不想改，怎樣?

留言

張貼留言

這個網誌中的熱門文章

使用 Airtable 在小型需求上取代傳統資料庫

作者： -
圖片
我好幾年沒有用傳統的關聯式資料庫了。 老實說，傳統的關聯式資料庫，其實對於教育訓練和小型的專案來說，是一種負擔。 如果你想讓學員清楚的掌握一門技術，就好比說，對談機器人的開發吧，在整個教學的過程中，若是範例用到SQL或MySQL資料庫，無疑是一種節外生枝，把問題變得更複雜。因為，在對談機器人當中，儲存只是一種迫不得已的額外需求，是枝微末節，而非對談機器人技術的主體。 同樣的，如果你做一個小型專案或POC的話，『儲存』也往往不是重點，儲存只是『必要之惡』。其實，若是從這個角度廣義的來說，軟體開發的GUI、資料庫，都只是細節(枝微末節)，都應該要是可以隨時被抽換或取代的部分，而非系統核心。 一套軟體或解決方案的真正核心，是商業邏輯。它(商業邏輯)才是一個應用程式真正展現價值的部分。 我們把主題拉回來。所以，我最近這幾年在上課的時候，盡量不讓範例程式碼涉及資料庫存取，特別是關聯式資料庫的存取。因為這對讀者或學員來說，變成了另一種必須學習的負擔。 但說的容易，如果範例中有碰到需要儲存資料的時候該怎麼辦呢? 有沒有什麼最簡單的儲存機制可以在程式碼中替代傳統資料庫? 這也是我最近幾年寫範例的時候，常常碰到的問題。因此，我特別花了一段時間，找看看有沒有什麼好用的『類』資料庫儲存體? 最後，我選擇了 Airtable。 Airtable Airtable 是一個靈活的雲端資料庫產品，結合了資料庫的功能和電子表格(data grid)的簡易性。它允許用戶以視覺化的方式存儲、組織和協作各種資訊： 白話一點說，就是它可以很自由的在Web畫面上設計欄位和維護(輸入、編輯)資料。 對我來說，它還有另一個重點，就是它擁有非常簡單的REST API，透過呼叫API就可以直接來讀寫資料。 它的API在使用上很簡單，只需要在設計好資料表之後，透過 https://airtable.com/create/tokens 站台建立一個 PAT(Personal Access Token): 建立PAT的時候，可以選擇要針對所有資料表，還是特定資料表，要只給這個token 讀取(Read)權限，還是要寫入(Write)權限： 有了token之後，可以透過很標準的REST API呼叫，進行連線的建立與資料的寫入： string ID = "👉air_tabl
Read more »

在POC或迷你專案中使用 LiteDB

作者： -
圖片
3/24，我發了篇FB 貼文 ，提到我很久沒有在撰寫範例的時候使用關聯式資料庫了。這不是因為關聯式資料庫不好，而是使用場景和情境的問題。 大部分的教學文章或範例，為求讓主題專注不要失焦，我會讓範例盡可能地簡單。例如，用Console App 取代 Web 架構，用file取代DB。這樣學員的進入障礙會再降低一點，畢竟，我們不能假設每一位學員都對MVC框架或是資料庫存取的ORM有認識。 那篇貼文得到不少迴響，其中有位讀者建議，也可以考慮用 LiteDB ，我當時回覆說我會找個時間來試試看。既然說了出口，肯定是必須要測試一下的。 LiteDB 技術上來說，LiteDB 是一個嵌入式的 NoSQL 資料庫，特別是針對 .NET 開發者設計。其本質上是一個檔案，但它提供了類似於傳統關聯式資料庫管理系統的功能，包括存儲、檢索、更新和刪除資料操作。LiteDB 以單一檔案的形式儲存在專案資料夾中，這使得它非常適合於輕量級應用。不管是desktop app、mobile app或任何需要資料庫但又不希望安裝重量級資料庫伺服器的情境，都很適合。 你只需要針對專案安裝 NuGet 套件就可以使用： dotnet add package LiteDB 不需要伺服器、不用管帳號密碼、可以跨平台，所有的資料都存儲在單一檔案，便於管理和分發、佈署。簡單的說，當我寫好範例，在裡面放一些資料，丟上GitHub，你不管在哪一個平台(Windows, Linux)，Clone下來之後，無須任何配置、設定，就可使用，資料也不會消失，無須重建。 確實，這對做範例非常方便。 你可以看看我在GitHub上的這個範例： git clone https://github.com/isdaviddong/TestLiteDB.git 下載下來之後，無須任何設定，直接 dotnet run 就可以執行： 專案中，包含了一個MyData.db檔案，就是資料庫實際儲存的位置： 你可以透過底下這樣的程式碼，即可使用： var db = new LiteDatabase ( "MyData.db" ) var col = db . GetCollection < Person > ( "persons" ) ; 其
Read more »

專業的價值...

作者： -
圖片
每次，我去修車的時候... 師傅說：先生你這車開那麼久了，這樣壞很正常拉，你要不要換台新的? 你不知道零件會老化嗎??? 我：是是是...那，這零件換掉要多少錢??? 師傅：喔...便宜啦，大概就XX萬就可以了... 每次，我去客戶那邊... 我說：大哥，這軟體我們用那麼多年了，總是會需要調整維護一下的... 客戶：是你們一開始沒有設計好吧? 我說：不是啦，技術總是會更新的，而且現在有一些新的需求...恩，大概，就收你XX萬就好了... 客戶：什麼? 你們當初沒設計好的東西，還想要加收錢??? -------------------------------------------------------------------------   我相信上面這樣的情況你一定和我一樣常碰到，我不知道有多少次，被修車廠唬的一愣一愣的，但我總是心甘情願地掏錢出來(好吧，我有點心不甘情不願，但我沒得選擇)。   有一次，我的動力方向盤打起來卡卡的，好像快不能正常轉向了，所以我立刻把車開到保養廠，師傅熱情的出來迎接我，問我車哪裡有問題，我描述狀況，接著師傅就把車開走了。剛好這時候我接到一通電話，我在講電話的同時，師傅把車弄好了(不到五分鐘)，跟我說，這個動力方向盤的油沒了，要補充，打折後收我一千多塊，我趕緊謝謝他。   離廠前，師傅把剩下的動力方向盤油給我(很有良心)，說：這是剩下的。我還沒反應過來，他就說：老闆，慢走，開車小心，注意安全。(好貼心的師傅)   我看了一下，那罐動力方向盤油只加了1/5，剩下4/5我要怎麼辦?放後車廂? 等他漏了再加? 我不知道!!! 他為何不乾脆 免費 幫我加一下呢? 像這樣類似的例子我碰過非常非常多(因為我的車老了，很多問題)   也有很多次，我明顯發現修車廠的人在唬爛我，但我換過很多家、原廠、副廠、出去玩的時候在風景區的修車廠(這更狠，擺明了就是要坑你，他清楚知道只會跟你做一次生意)，幾乎都一樣，我常常有被唬弄的感覺。我想要跟著車看他怎麼修，修車廠的師傅總是說：『老闆，您可以到休息室等一下，不會那麼快喔!!!』   對照先前我在軟體社群看到有位朋友寫的一篇 文章 ，提到了軟體工程師的無奈和心酸，我其實很想說，軟體工程師大部分真的都太古意了!!!!   從商人的角度來看，每一次免費的服務，其
Read more »

精彩(且驚人)的Semantic Kernel入門範例

作者： -
圖片
之前開直播的時候，和線上朋友聊到，因為AI的出現，未來的應用程式，勢必會和現在有所不同。 先不要跳到 黃仁勳 說的，未來『每個開發人員都可以直接用自然語言做程式設計』(這樣也太駭人聽聞了一點)，先看看眼下我們可以做到什麼程度。 你會發現透過 Semantic Kernel，這個所謂的 AI 開發框架，已經可以做到， 讓 AI 自己決定何時(以及如何)呼叫一個類別(Class)中的方法(Method) 。而我們只需要讓用戶輸入對話與機器人對談，就可以控制程式運行的流程與邏輯。也就是說，現在不需要滑鼠點選，不用選單操作，只要與機器人透過自然語言對談(底下的範例是打字，但當然可以是語音)，就可以操控系統。 我前陣子一直說的，AI 會讓 GUI 有著天翻地覆的改變，意即如此。 看底下這個類別的程式碼： //控制開關燈的類別 public class LightPlugin { //當前燈的狀態 public bool IsOn { get; set; } = false; [KernelFunction] [Description("取得燈的狀態")] public string GetState() { return IsOn ? "on" : "off"; } [KernelFunction] [Description("改變燈的狀態")] public string ChangeState(bool newState) { this.IsOn = newState; var state = GetState(); // Print the state to the console Console.WriteLine($"[Light is now {state}]"); return state; } } 上面這個很簡單的 LightPlugin 類別，具有兩個方法：GetState 和 ChangeState。這兩個方法都被標記為 [KernelFunctio
Read more »

周末讀書會 - 一如既往

作者： -
圖片
一般來說，我都是看完整本書之後，才會決定要不要推薦，能讓我還沒看完就忍不住推薦的書極少。 但『一如既往』，就是這極少中的之一。 這本書的主題很難界定，你既可以說它是在談投資、也可以說他在談經營或企管、有些內容說的是競爭、但有時候你會覺得他講的是人生。 然而重點在於，這本書寫得非常好看。 我超愛的科幻小說家倪匡，曾說過：『好看的小說非常簡單，必定要有豐富的情節、鮮活的人物，小說寫得不好看，裏面有再多的學問、道理、藝術價值，都沒有用。』 一如既往，這本書的作者厲害之處，就是他能夠把每一篇都寫得環環相扣、異常好看，然而即便我知道每篇文章的pattern，想要模仿也是很難(這是個苦功來著)。 基本上那個pattern就是…以引人入勝的故事開頭，使用對照法讓故事撐托出主題，以極具說服力的文字或數據讓主題凸顯出價值，讓讀者有所收穫，最後在最短的文字內把一篇文章總結，然後預告下一篇作者想要接著談論什麼。 就這樣，你會一篇接著一篇，不由自主的閱讀下去，每一篇，你都會有一些驚訝、會有一些省思、接著會有一些take a way。 整本書，看似信手拈來、行雲流水，一氣呵成。但我知道，這是精心設計與編排後的結果。 一本書，最要緊是好看。 好看，讓人讀得下去，裡面豐富的內容才對身為讀者的你有意義。 『一如既往』這本書做到了，而且做得很徹底。 我快看完了，看完之後，如果有時間，我還想針對裡面某幾篇特別分享，如果你等不及，不妨先找來看看。
Read more »