DataWorks的強制代碼評審是工作空間維度開啟,開啟后,開發人員提交的節點代碼必須通過評審人員的審核才可發布。同時,您可指定代碼評審的基線范圍(即對哪類基線任務進行評審),把控高優先級任務的代碼質量,防止任務運行失敗阻塞其他任務運行。本文為您介紹代碼評審的使用說明。
前提條件
已開通DataWorks專業版及以上版本。DataWorks標準版、專業版、企業版的功能對比,詳情請參見DataWorks各版本詳解;開通DataWorks,詳情請參見購買指引。
已具備空間管理員角色權限,詳情請參見用戶、角色與權限概述。
創建節點并進行數據開發,詳情請參見數據開發概述。
背景信息
DataWorks的多個任務并發啟動運行時,高優先級的任務會優先搶占資源。因此,為避免高優先級任務因代碼不合規導致任務失敗,從而長時間占用資源導致計算資源浪費,阻塞其他任務運行,建議將高優先級的任務添加至強制代碼評審基線范圍,添加后,評審人員需對任務的代碼質量進行把控,防止由于任務代碼有誤,未經審核直接發布上線后出現任務報錯。
開啟強制代碼評審對節點提交發布流程的影響如下。
強制代碼評審開啟情況 | 功能說明 | 操作影響 |
未開啟強制代碼評審 | 提交節點時,通過指定代碼評審人員的方式知會相關人員當前節點存在變更。 說明 此方式可知會工作空間下任意角色成員節點的變更情況。 | 該操作對節點的提交發布流程無影響,節點可正常提交發布。 |
開啟強制代碼評審 | 提交節點時,選擇具有評審資格的人員進行代碼評審,把控代碼質量。 說明 若執行的是刪除節點操作,則提交該節點時不會觸發代碼評審。 | 該操作會阻塞節點的提交發布流程,即暫停當前節點代碼的提交發布,進行代碼評審。
|
使用限制
僅DataWorks專業版及以上版本支持使用代碼評審。
僅空間管理員權限的用戶才可管理工作空間是否啟用代碼評審。
特殊類型節點(例如,循環、遍歷等組合型節點以及非Python的資源文件)不支持發起代碼評審。
使用流程
強制代碼評審的使用流程如下表。
步驟 | 執行角色 | 說明 |
空間管理員 | 空間管理員可開啟代碼強制評審并根據業務需求配置評審人員及待評審的節點范圍。開啟后強制代碼評審才會生效。 說明 開啟強制代碼評審會阻塞節點的提交發布流程。 | |
開發人員 | 開發人員提交節點時將觸發代碼評審,選擇評審人員后將生成評審單。 說明 標準模式工作空間下,開發人員可通過任務發布界面批量發起代碼評審,詳情請參見發布任務。 | |
| 節點提交人及代碼評審人可通過代碼評審界面查看并處理已發起的評審及名下待評審記錄。 |
開啟強制代碼評審并配置評審信息
登錄DataWorks控制臺,切換至目標地域后,單擊左側導航欄的 ,在下拉框中選擇對應工作空間后單擊進入數據開發。
進入安全設置與其他界面。
在DataStudio頁面單擊左下角的圖標,進入設置頁面。
單擊設置頁面的安全設置與其他頁簽,進入安全設置與其他頁面。
開啟強制代碼評審并配置評審信息。
在代碼評審區域,您可開啟代碼強制評審開發后,設置評審人員及評審基線范圍。
參數
描述
強制評審
用于配置當前工作空間指定范圍內的節點提交時是否要進行代碼評審。
開啟:當前工作空間的節點代碼提交時將強制進行代碼評審,您需要指定代碼評審人,待評審通過后才可發布。該操作會阻塞節點的提交發布流程。
說明開啟強制評審后才可設置項目代碼評審人及指定強制代碼評審基線范圍。
關閉:當前工作空間的節點代碼提交時無需進行代碼評審即可發布。您也可以選擇在節點提交時配置代碼評審人,但該操作僅為知會相關人員節點此次的變更操作,不會阻塞節點的提交發布流程。
項目代碼評審人
用于配置提交節點時選擇的評審人員策略。
任意開發角色用戶:節點發起代碼評審后,需要當前工作空間下任意開發角色的用戶評審通過后才可提交發布。具體由哪個用戶評審,則在提交節點時由節點提交人進行選擇。
指定開發角色用戶:節點發起代碼評審后,必須由指定開發角色的用戶評審通過后才可提交發布。提交節點時默認由此處配置的評審人員進行評審。
說明僅支持選擇當前工作空間下具有開發角色權限的用戶作為評審人員。
DataWorks支持配置一個或多個代碼評審人。當配置多個評審人時,代碼是否通過評審,取決于您選擇的評審人員策略。
指定強制代碼評審基線范圍
用于配置哪些節點在提交時需要進行代碼評審。
您可根據任務所在的基線優先級來選擇要強制進行代碼評審的節點,邏輯說明如下:
設置基線評審范圍為非基線任務時,當前工作空間中新建的任務需要審批。
設置基線評審范圍為對應級別的基線任務時,當前工作空間中該級別基線上的節點提交時需要審批。
基線任務的數值越大優先級越高,基線任務的優先級高于非基線任務。
關于基線控制任務優先級的相關介紹,詳情請參見智能基線概述。
發起代碼評審流程
開發人員在提交節點時,可指定一個或多個代碼評審人員。不同模式的工作空間代碼評審流程說明如下表。
當節點已存在正在進行的代碼評審,發起新的評審后,舊評審流程的結果將自動作廢,不再生效。
若執行的是刪除節點操作,則提交該節點時不會觸發代碼評審。
工作空間模式 | 評審流程說明 | 代碼評審入口 |
標準模式 | 開啟強制代碼評審后,節點的提交發布流程將被阻塞直至節點代碼評審通過。評審通過后,節點才會被提交,您可進入任務發布界面繼續發布任務。 |
|
簡單模式 | 開啟強制代碼評審后,提交節點時選擇僅發起代碼評審,需要待評審通過后再次單擊提交,節點代碼才會被提交至生產環境。 |
|
查看與審批代碼評審單
進入代碼評審頁面。
您可通過如下方式進入代碼評審頁面:
在DataStudio頁面單擊頂部菜單欄左側的圖標,選擇
。在目標節點的編輯頁面,單擊工具欄的圖標進入。
查看并處理評審單。
在代碼評審頁面,您可查看名下已發起或參與審核的評審任務列表,并根據實際情況處理評審任務。
區域
描述
1
在該區域可執行如下操作:
代碼評審人員可在我審核的頁簽查看并處理名下的評審任務。
節點提交人可在我發起的頁簽查看名下已發起的評審任務。
2
在該區域,您可通過評審狀態、評審單名稱、類型、提交人、提交時間等條件進行篩選,查找符合條件的評審單。
3
在該區域,可查看評審單的版本、評審狀態等基本信息,或查看評審單詳情并處理評審。
查看詳情及處理評審單主要包括:
版本對比:對比節點不同版本的代碼差異,快速了解節點變更。
代碼審核人處理評審單:
評論:添加節點版本的描述。
通過:該操作會觸發代碼審核檢查器進行檢查。審核通過后節點提交人可進入任務發布界面發布該任務。
說明發布任務,詳情請參見發布任務。
不通過:根據當前工作空間是否開啟強制代碼評審進行處理。已開啟則會阻塞節點的提交發布,未開啟則評審節點仍可繼續提交發布。
廢棄:廢棄當前評審流程。廢棄后,當前節點版本可繼續提交發布。
重開:若您需要對已廢棄的評審流程重新評審,則可執行重開。