コードレビューは、手動チェックを通じて本番コードを最適化するプロセスです。このプロセスにより、定期タスクのコード品質が向上し、本番環境のコードが必要な基準を満たしていることが保証されます。ビジネスニーズに応じて、タスクを本番環境にデプロイする前に手動でのコードレビューを必須にすることができます。必須レビューが有効になっている場合、レビューに合格したタスクのみがデプロイできます。
仕組み
DataWorks では、必須レビューを有効にすることで、非準拠コードによるタスクの失敗を防ぎ、コンピューティングリソースの浪費を回避できます。この機能が有効な場合、レビュー担当者はタスクコードをチェックして、承認されていないコードがデプロイされるのを防ぐ必要があります。
必須レビューが無効な場合：ノードを送信する際に、手動でコードレビューを開始できます。レビュー結果に関係なくノードをデプロイできます。
必須レビューが有効な場合：ノードを送信する際に、コードの品質を保証するために、適格なレビュー担当者を選択する必要があります。
レビューが承認された場合は、ノードのデプロイに進むことができます。
レビューが承認されない場合、ノードはデプロイできません。フィードバックに基づいてコードを修正し、再度レビューのために送信する必要があります。ノードは承認後にのみデプロイできます。
制限事項
コードレビュー機能は DataWorks Professional Edition 以降でのみ利用可能です。DataWorks Professional Edition またはそれ以上のエディションを有効化していることを確認してください。エディションの詳細については、「DataWorks の各エディションの機能」をご参照ください。
Alibaba Cloud アカウント (root ユーザー)、スペース管理者、または AliyunDataWorksFullAccess 権限を持つ RAM ユーザーのみが、ワークスペースのコードレビューを有効または無効にできます。詳細については、「ユーザー、ロール、権限の概要」をご参照ください。
コードレビューは、ループノードや走査ノードなどの複合ノード、または Python 以外のリソースファイルなど、特殊なノードタイプには対応していません。
(任意) 管理者向け：必須レビューの有効化
ワークスペース管理者は、Data Studio の設定ページで以下の手順に従って、ワークスペースの必須レビューを有効にできます。
必須レビューが無効な場合でもレビューを開始できますが、デプロイプロセスはブロックされません。
ノードを削除しても、コードレビュープロセスはトリガーされません。
セキュリティ設定などへのアクセス
DataWorks コンソールの ワークスペースページに移動します。上部のナビゲーションバーで、目的のリージョンを選択します。目的のワークスペースを見つけ、操作列で を選択します。
Data Studio の設定ページに移動します。
左下隅の
アイコンをクリックし、[Data Studio 設定] を選択します。セキュリティ設定などに移動します。
Data Studio 設定ページで、Security Settings and Others タブをクリックします。
コードレビューの有効化
Security Settings and Others タブの で、[必須レビュー] スイッチをオンにします。
Security Settings and Others タブに [必須レビュー] スイッチが見つからない場合は、ご利用の DataWorks のエディションを確認してください。この機能には DataWorks Professional Edition またはそれ以上のエディションが必要です。
パラメーター | 説明 |
必須レビュー | 現在のワークスペースのタスクを本番環境にデプロイする前に、コードレビューが必要かどうかを制御します。 |
コードレビュー担当者 | コードをレビューできるユーザーを指定します。
説明
|
必須コードレビューのベースライン範囲を指定 | 送信時にコードレビューが必要なノードを指定します。 ノードが属するベースラインの優先度に基づいて、どのノードに必須レビューが必要かを決定できます。ロジックは次のとおりです：
説明 非ベースラインタスクを選択すると、ワークスペースで作成されたすべての新しいノードに承認が必要になります。 |
Code Review Notification Method | 必須レビューを有効にした後、詳細な通知メカニズムを設定して、重要な情報が関連担当者に自動的に配信されるようにすることができます：
次の通知方法がサポートされています：SMS、DingTalk グループロボット Webhook、Mail、WeChat Group Webhook、Lark Webhook、および Standard Webhook。 コードレビューアラートの SMS メッセージと電話は、アラートリソースとしてカウントされます。管理コンソールの アラートリソース ページで、コードレビューモジュールのアラートリソースの使用状況を確認できます。詳細については、「アラートリソースの表示と設定」をご参照ください。 説明
|
レビュー開始者向け：コードレビューの送信
ノードを送信すると、コードレビュープロセスがトリガーされます。レビュー担当者を選択すると、レビューリクエストが生成されます。管理者が必須レビューを有効にしている場合、デプロイプロセスは本番環境チェッカーの段階でブロックされます。ノードは、コードレビューが承認された後にのみ本番環境にデプロイできます。
あるノードに対してコードレビューがすでに進行中の場合、同じノードに対して新しいレビューリクエストを送信すると、古いレビュープロセスの結果は自動的に無効になります。
ノードを削除しても、コードレビューはトリガーされません。
タスクをデプロイします。
アイコンをクリックしてノードを保存し、
アイコンをクリックして Online publishing content ページに移動します。Start Release Production をクリックします。必須レビューが有効になっているため、レビューが承認されるまで、デプロイプロセスは本番環境チェッカーの段階でブロックされます。
コードレビューを開始します。
Initiate Code Review をクリックします。Code Review ダイアログボックスで、Code Reviewer と Description of change を設定します。
パラメーター
説明
Code Reviewer
コードレビュー担当者のリストから 1 人または複数のユーザーを選択します。
Description of change
コードの変更内容を記述します。
設定が完了したら、Confirm をクリックしてコードをレビューに送信します。
レビュー担当者向け：レビューリクエストの処理
レビュー担当者は、 タブで、保留中のレビューリクエストを表示および処理できます。
コードレビューページに移動します。
Data Studio の左側のナビゲーションウィンドウで、
アイコンをクリックして [コードレビューリスト] ページに移動します。[自分のレビュー] タブでは、自分に割り当てられたレビューリクエストを表示できます。レビューリクエストを処理します。
タブで、レビューリクエストの詳細を表示し、それに対して操作を実行できます。
コードレビューリストページ：レビューリクエストをすばやく By、Reject、Abandoned、Reopen、または Share できます。
コードレビュー詳細ページ：
[コードレビューリスト] ページで、レビューリクエストをクリックして、その [コードレビュー詳細] ページに移動します。このページでは、本番環境のバージョンと比較したコードとスケジュール構成の変更を確認できます。その後、レビューリクエストを承認するかどうかを決定できます。
レビュー操作セクションで、レビュー担当者はリクエストに対して次の 操作 を実行できます：
：承認
：拒否
：破棄
：再開Comments
説明Abandoned：現在のレビュープロセスをキャンセルします。破棄されたリクエストは、再開されるか、ノードが再度レビューのために送信されるまでデプロイを防ぎます。
Reopen：破棄されたリクエストのレビュープロセスを再開するために Reopen を選択できます。
コードレビューが完了すると、レビュー開始者は [コードレビューリスト] ページでレビューの詳細を確認し、レビューリクエストを管理できます。
レビュー開始者向け：レビュー結果の確認
レビュー開始者は、 タブでレビュー結果を表示し、リクエストを管理できます。
コードレビューページに移動します。
Data Studio の左側のナビゲーションウィンドウで、
アイコンをクリックしてコードレビューページに移動します。Created by Me タブで、作成したレビューリクエストを表示できます。レビュー結果を確認します。
タブで、レビューリクエストの詳細を表示し、それに対して操作を実行できます。
コードレビューリストページ：レビュー開始者は、レビューリクエストの結果をすばやく表示し、Abandoned、Reopen、または Share などの操作を実行できます。
説明この操作は現在のレビュープロセスを破棄します。リクエストが破棄された後、現在のノードバージョンは再度レビューのために送信されるか、リクエストが再開されるまでデプロイプロセスを続行できません。
コードレビュー詳細ページ：[コードレビューリスト] ページで、レビューリクエストをクリックして、その [コードレビュー詳細] ページに移動します。その後、コードレビューを Reopen するか Abandoned するかを決定できます。
レビューが承認されない場合、ノードはデプロイできません。フィードバックに基づいてコードを修正し、再度レビューのために送信する必要があります。ノードは承認された後にのみデプロイできます。
次のステップ
コードレビューが承認された場合は、デプロイを続行できます。拒否された場合は、コメントに基づいてコードを調整し、再度レビューのために再送信する必要があります。