程式碼檢閱旨在通過人工幹預最佳化生產代碼,以提升生產調度任務的代碼品質,確保生產環境中的代碼符合規範。您可以根據業務管理要求,決定是否在任務發布至生產環境之前強制進行人工程式碼檢閱。一旦開啟強制程式碼檢閱,只有通過評審的任務才能發布至生產環境。
功能介紹
在DataWorks中,為了避免因代碼不合規導致任務失敗,從而長時間佔用資源造成計算資源的浪費,可以開啟強制程式碼檢閱。開啟後,評審人員需對任務的代碼品質進行嚴格把控,以防止因任務代碼錯誤而造成未經審核通過的代碼無法發布上線。
未開啟強制程式碼檢閱:提交節點時,可手動發起評審,無論評審通過與否,均可正常發布。
開啟強制程式碼檢閱:提交節點時,選擇具有評審資格的人員進行程式碼檢閱,把控代碼品質。
當評審通過後,節點繼續提交發布。
當評審未通過時,節點無法被提交發布,您需根據評審意見先進行修改,再次發起評審,直至評審通過後才可繼續提交發布節點。
使用限制
僅DataWorks專業版及以上版本支援使用程式碼檢閱,確保已開通DataWorks專業版及以上版本,版本詳情可參見DataWorks各版本功能詳情。
僅主帳號、空間管理員以及擁有AliyunDataWorksFullAccess許可權的RAM使用者才可管理工作空間是否啟用程式碼檢閱。詳情請參見使用者、角色與許可權概述。
特殊類型節點(例如,迴圈、遍曆等組合型節點以及非Python的資源檔)不支援發起程式碼檢閱,
(可選)管理者:開啟強制程式碼檢閱
空間管理員可以參考下文在Data Studio設定頁面為工作空間開啟強制程式碼檢閱。
未開啟強制程式碼檢閱的情況下,您也可發起評審,但不會阻塞發布流程。
若執行的是刪除節點操作,則提交該節點時不會觸發程式碼檢閱。
進入安全設定與其他頁面
進入DataWorks工作空間列表頁,在頂部切換至目標地區,找到目標工作空間,單擊操作列的,進入Data Studio。
進入Data Studio設定頁面。
單擊左下角
按鈕,選擇Data Studio設定,開啟Data Studio設定頁面。進入安全設定與其他。
在Data Studio設定頁面,切換頁簽至安全設定與其他頁簽。
開啟程式碼檢閱
在安全設定與其他頁簽下,開啟。
如果您在安全設定與其他頁簽下未找到強制評審開關,請確認您的DataWorks版本,當前僅DataWorks專業版及以上版本支援使用程式碼檢閱。
參數 | 描述 |
強制評審 | 用於控制當前工作空間任務發布生產環境前是否必須進行程式碼檢閱。 |
專案程式碼檢閱人 | 自訂程式碼檢閱人員。
說明
|
指定強制程式碼檢閱基準範圍 | 用於配置哪些節點在提交時需要進行程式碼檢閱。 您可根據節點所在基準的優先順序確定需要強制進行程式碼檢閱的節點,邏輯說明如下:
說明 選擇非基準任務時,意味著工作空間建立節點需要審批。 |
DingTalk群機器人webhook | 填寫DingTalk群自訂機器人Webhook後,可以在群內收到由自訂機器人發出的程式碼檢閱狀態變更訊息。您可參考文檔配置自訂機器人。 說明 DingTalk群機器人安全配置僅支援配置關鍵字,並且關鍵字需要包含 |
DingTalk群程式碼檢閱是否@所有人 | 開啟後,程式碼檢閱狀態每次變更均會在DingTalk群內 |
評審發起人:發起程式碼檢閱
提交節點時將觸發程式碼檢閱,選擇評審人員後將產生評審單。若管理者開啟了強制程式碼檢閱,發布流程在生產檢查器階段進行阻塞,只有程式碼檢閱通過後,才能將節點發布至生產環境。
當節點已存在進行中的程式碼檢閱,發起新的評審後,舊評審流程的結果將自動作廢。
若執行的是刪除節點操作,則不會觸發程式碼檢閱。
發布任務。
單擊
表徵圖,儲存需要發布的資料開發節點,再單擊
表徵圖進入上線發布內容頁面。單擊開始發布生產按鈕,進行發布,由於開啟了強制程式碼檢閱,所以發布流程在生產檢查器階段進行阻塞,只有程式碼檢閱通過後,才能發布。
發起程式碼檢閱。
單擊發起程式碼檢閱,在程式碼檢閱配置頁面,配置程式碼檢閱人與變更描述。
配置項
描述
程式碼檢閱人
選擇該控制項下配置的專案程式碼檢閱人,可指定一個或多個程式碼檢閱人員。
變更描述
描述代碼變更資訊等內容。
配置完成後,單擊確認,提交程式碼檢閱。
評審處理人:處理評審單
程式碼檢閱處理人可在菜單下查看名下待評審記錄,並處置評審單。
進入程式碼檢閱頁面。
單擊資料開發(Data Studio)頁面左側導覽列上的
表徵圖,進入程式碼檢閱列表頁面,即可查看我評審的代碼審批單。處置程式碼檢閱單。
在頁面,可查看程式碼檢閱的詳細資料,並對評審單進行相應操作。
在程式碼檢閱列表頁:可快速對評審單進行通過、拒絕、廢棄、重開以及分享操作。
在程式碼檢閱詳情頁:
在程式碼檢閱列表頁面單擊需要評審的程式碼檢閱單,進入程式碼檢閱詳情頁面,在代碼詳情頁面可以查看本次評審代碼、調度配置相較於生產線上版本的變化,可決定是否通過本次程式碼檢閱。
評審處理人在評審操作模組,可對評審單進行以下評審操作:
:通過。
:拒絕。
:廢棄。
:重開。評論。
說明廢棄:廢棄當前評審流程。廢棄後,當前節點版本可直接提交發布。
重開:若您需要對已廢棄的評審流程重新評審,則可執行重開。
完成程式碼檢閱後,評審發起人即可在程式碼檢閱列表頁面查看評審詳情以及操作評審單。
評審發起人:查看評審結果
評審發起人可在菜單下查看評審結果,並處置評審單。
進入程式碼檢閱頁面。
單擊資料開發(Data Studio)頁面左側導覽列上的
按鈕進入程式碼檢閱頁面,即可查看我建立的程式碼檢閱單。確認評審結果。
在頁面,可查看程式碼檢閱的詳細資料,並對評審單進行相應操作。
在程式碼檢閱列表頁:評審發起人可快速查看評審單結果,以及進行廢棄、重開或分享操作。
說明廢棄當前評審流程,廢棄後,當前節點版本需再次提交評審或重開評審單後可繼續進行發布流程。
在程式碼檢閱詳情頁:在程式碼檢閱列表頁面單擊相應的程式碼檢閱單,進入程式碼檢閱詳情頁面,可決定是否重開或廢棄本次程式碼檢閱。
當評審未通過時,節點無法被提交發布,您需根據評審意見先進行修改,再次發起評審,直至評審通過後才可繼續提交發布節點。
後續步驟
程式碼檢閱通過後,即可繼續進行發布流程。若程式碼檢閱未通過,可根據評審評論進行代碼調整後重新發起程式碼檢閱。