使用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你說的對，我錯。但我不想改，怎樣?

留言

張貼留言

這個網誌中的熱門文章

使用LM Studio輕鬆在本地端以API呼叫大語言模型(LLM)

作者： -
圖片
最近上課常被問到，如何在地端環境搭建出大語言模型(LLM)，並且呼叫其API。 一開始我不太理解為何會有這樣的需求(因為在地端自行搭建運行LLM的成本不一定比較低，即便可能比較安全)，但被問多了，也就開始遍尋相關的解決方案，看看有沒有什麼最簡單的方式，可以讓開發人員在地端測試大語言模型? 後來我選擇 LM Studio ，它就是一款設計來運行大型語言模型（LLM）的平台，有個算是挺優雅的整合環境，讓一般 end-user 或開發人員，都可以輕易地在 local 端進行模型的部署和測試。 LM Studio 本身支援多種模型架構和框架，當然，最重要的是，它是免費的。 下載安裝 都很容易，我就不多說。 安裝好之後，你可以看到首頁中已經呈現了許多 Hugging Face上的模型： 這顯然是因為Hugging Face是大部分免費開源模型的集散地。 你可以搜尋自己喜歡的模型，透過LM Studio下載到local之後，就可以直接載入(下圖一)： 隨手設定一下 system prompt(上圖二)，然後，就可以直接對談了。(上圖三) LM Studio會使用你的GPU進行運算(如果有的話)，你會發現，原來有好的設備(GPU)，運行的速度可以如此之快。 Local Server 對於開發人員來說，它還有個超級更友善的功能。 LM Studio本身還提供一個 local server，可以幫你把模型包裹起來讓你直接透過API呼叫該模型的功能，例如： 上圖是我們開啟 LM Studio中 Local Server功能後的結果，你可以透過 localhost 的 1234 port 來呼叫這個被 LM Studio 運行起來的大語言模型。(有沒有發現，我們用的也是 chat/completions API) 透過Postman簡單提供一下 JSON Body: { "model": "LM Studio Community/Meta-Llama-3-8B-Instruct-GGUF", "messages": [ { "role": "system", "content": "你是AI助理，請一律用繁體中...
Read more »

VS Code的字體大小

作者： -
圖片
身為.net developer，這年頭是什麼code都得要會寫的年代。 而雖然我的NB還沒從Windows淪陷為Mac OS，但寫Node.js和Python免不了要用VS Code，這是一種愛的表現。 但歲月不饒人，盡管微臣非常熱於配合，但VS Code預設字體的大小在我還沒錢買大尺寸螢幕的狀況下，實在讓老臣難以適應。當下的第一個反應是什麼? 當然是 Ctrl+滑鼠滾輪往上推…哇靠，沒用。看…這設計…恩，千錯萬錯一定是我的錯。 只好從選單 file –> Preferences –> Settings: 在出來的視窗中，你可以看到 editor.fontsize: 沒錯，改它就行了。改不動? 喔，不好意思，我沒仔細看說明，要copy到右邊是吧，沒問題，copy->paste->modify->Save…搞定。 好簡單啊…連ctrl+(mouse scroll up)都用不到了呢… 咦?這是一篇抱怨文嗎? 沒有，誰說的? 免費的tool我們還有什麼好抱怨的呢…要感恩啦。 啊….對了，如果你還是堅持要使用 Ctrl+滑鼠滾輪，請找關鍵字… "editor.mouseWheelZoom"
Read more »

使用 Dify 建立企業請假機器人

作者： -
圖片
八卦與未來 上個月，前Google執行長Eric Schmidt在史丹福有場演講，媒體關注的是八卦消息(如果你也曾關注，網路上有很多鐵定可以找到)，但我注意到的則是他提到了自己認為接下來 AI(特別是大語言模型) 可能的發展方向，包含: Large Context Window AI Agent Text-to-Action 底下這邊有這一個段落的影片： https://www.youtube.com/watch?v=zl3k1ksFZdY 為何我會關注這部分? 因為上述的三個方向，也是身為開發人員的我，過去這一年，來與LLM打交道後的感想。昨天，我在 twMVC 的研討會分享中，展示了一個其實我過去早做過了N百次的範例，就是企業的請假機器人。(唯一不同的是，這次我幾乎沒有寫任何程式碼) 場景是，員工在家裡生病了，想要透過語音或是app進行請假，你可以看底下這個運行的範例 (git圖檔會循環播放，開始是 『我好像感冒了』)： 用自然語言對談的方式，即可完成請假。 我說過，類似這樣的範例我做過很多次，用 LINE Bot 搭配 C# 做過，用MS Bot Framework 做過，前陣子也用 Semantic Kernel 框架做過，更早期，還沒有AI的時代，我也在EIP和HR系統裡做過。 但我想說的是，這 就是 Text-to-Action 的呈現，也是一個典型的 AI Agent 的例子，它讓我們透過自然語言(可以是語音或文字)，直接命令機器人(Chat Bot、AI 助理、Agent、Assistant …不管你叫它什麼…)幫你完成一件事情(請假、售票、查詢資料、做財務報表、統計圖表、寫程式…etc.)。 這是一直以來人類對電腦最底層的需求與期待。 隨著 LLM 能夠處理和記憶的 Context 愈來愈被放大，AI Agent 所能夠處理的任務就更加的不受限制。 自然語言才是最符合人類直覺的操作 順帶一提，我昨天在研討會中講了一個故事。 有天，你覺得自己需要聘請一位助理，因此上網張貼徵人啟事，沒多久，你找到了一位號稱上知天文、下知地理的高材生，來幫助你更有效率的完成工作。 他什麼都好，唯一的一個小缺點是，你不能直接對這個助理下達指令，你必須用一種只有這個助理看得懂的語法，才能要求這個助理幫你完成特定的工作。這些語法還挺...
Read more »

使用 Dify API 快速建立一個包含前後文記憶的對談機器人

作者： -
圖片
Dify 這個產品我就暫時先不介紹了，它找到了一個挺好的切入點跨入AI Agent市場。讓不喜歡(或不擅長)寫太多 Code 的開發人員，也可以快速的建立一個具有前後文、記憶的對談機器人。 其實若單就設計 Chat Bot 來談，它本質上和 GPTs 有那麼一點點像，你只需要給一個 system prompt ，再加上一點點的資料上傳做為 RAG 的數據來源，就可以生出一隻有模有樣的對談機器人。 但 GPTs 做出來的 Chat Bot 被綁在 ChatGPT 的 UI 裡面，你不容易把它跟 LINE Bot (LINE 官方帳號) 或其它 UI (例如 MS Teams) 串在一起，而 Dify 呢? 則給你了一個 chat-messages API，讓你能很快的實現這個功能，把你在 Dify 平台上做好的 Chat Bot 轉變成可以正式運行的 LINE Bot 或 其它 Bot。 這也是今天我們要介紹的部分。 建立 Assistant 我們先用 Dify 以底下這個 system prompt 建立了一個請假助理： 發佈後，你可以在Dify 內建的 Web UI 上測試： 你會發現，這個 chat bot 已經有著基本的記憶，然後可以依照 system prompt 完成對談和任務。 不要問我在這邊建立出一個假單有什麼用，正常情況下是要直接讓 chat bot 寫入資料庫(例如 HR 系統，直接完成請假)，只是我們還沒談到這一段，這部分以後再展開來談。 chat-messages API 好，透過上面那樣建立一個對談機器人超容易，且內建就有了記憶和前後文的功能。讓開發人員快樂的不得了。跟使用無腦 GPTs 生成術差不多。然而，如果只能在 Web 上用，不能串接 MS Teams、LINE…等介面，做了也是白搭。 但，Dify 貼心的提供了 API，我們來試試看。先Gen個 API Key： 生成了 API key 之後，你只需要透過底下這樣的 rest api，即可進行呼叫： 你會發現，開發人員只要使用單一的這一個 https://api.dify.ai/v1/chat-messages API 即可進行對談。每次只需要透過 query 輸入用戶說的話，response 中的 answer 則是 LLM (Assist...
Read more »

使用 Dify 串接 LINE Bot

作者： -
圖片
一開始寫這篇文章的時候，我有點困擾。 到底這一篇我到底該命名 『使用 Dify 串接 LINE Bot』 ，還是 『使用 LINE Bot 串接 Dify』?? 但我想，反正你應該知道我的意思，本文就是討論如何把兩者串在一起。 如果不熟悉 Dify ，本篇文章的前面還有兩邊文章你可以簡單的介紹了一下，所有連結位置在底下: https://studyhost.blogspot.com/search?q=dify 總的來說(我20年前就這麼說話了，最近有人說AI很喜歡說『總的來說』，但顯然是AI學我的)，我們可以在 Dify 裡面設計一個類似底下這樣的 workflow，他可以是一個簡單的對談聊天機器人，也可以是串接到後端HR請假系統，可以協助企業進行請假的 AI 助理： 顯而易見，使用 Dify 的好處很多。而在這邊它對我們來說，意義上是一個所視即所得的 Chat Bot(AI助理)設計平台，你可以在 Dify 中先把對談流程設定好，並且進行測試。 設計初步完善之後，我們可以透過Dify API來進行串接，例如串接到 Teams Bot或是LINE Bot。API的部分我們之前在 這一篇 介紹過。 由於Dify內建處理了對談前後文與記憶的部分，並且可以直接串接OpenAI的API(或是其它LLM亦可，同時也便於抽換)，這讓我們開發 AI 助理輕省不少。 這也是我覺得 Dify 作為一個 LLMOps 開發平台(Platform)應該算是當之無愧的原因了。 串接到 LINE Bot 那在Dify上開發測試完之後，我們當然希望能夠整合在 LINE Bot(或是隨便其它什麼 Bot)上面。前面說過，由於 Dify 有提供一組API，我們可以透過該API輕易地進行串接，API的部分，我們在先前 這一篇 介紹過。因此，我們底下要更進一步，談談如何實際跟 LINE Bot 整合在一起。 其實架構上不複雜，我們只需要建立一個 LINE Bot 的 WebHook ，並且在其中呼叫 Dify API即可： 也就是上圖中，紅色虛線框起來的這一段。 這部分該如何進行呢? 倒也容易，我們看底下 WebHook 的部分： var responseMsg = "" ; //準備回覆訊息 if ( LineEvent != n...
Read more »