コードレビューは、手動レビューのプロセスを通じて本番環境タスクのコード品質を向上させ、本番環境に公開されるコードが品質基準を満たすことを保証します。必須コードレビューを有効にすることで、タスクがレビューを通過しない限り公開されないように設定できます。
仕組み
DataWorks では、必須コードレビューを有効にして、非準拠コードによるタスク失敗やコンピューティングリソースの無駄を防止できます。この機能を有効にすると、コードを公開する前にレビュアーによるレビューと承認が必要になります。
必須コードレビューが無効の場合：ノードを手動でレビューに提出できます。レビュー結果に関係なく、ノードを公開できます。
必須コードレビューが有効の場合：ノードを提出する際に、適格なレビュアーを選択してコードレビューを依頼する必要があります。
レビューが承認された場合、ノードを公開できます。
レビューが拒否された場合、フィードバックに基づいてコードを修正し、再度レビューに提出する必要があります。承認後にのみノードを公開できます。
制限事項
コードレビューを使用するには、DataWorks Professional Edition またはそれ以上のエディションを有効化している必要があります。エディションの詳細については、「DataWorks エディション」をご参照ください。
Alibaba Cloud アカウント、ワークスペース管理者、または AliyunDataWorksFullAccess 権限を持つ RAM ユーザーのみが、ワークスペースのコードレビューを有効または無効にできます。詳細については、「ユーザー、ロール、権限の概要」をご参照ください。
コードレビューは、ループやトラバースなどの複合ノードや、Python 以外のリソースファイルではサポートされていません。
（オプション）必須コードレビューの有効化
ワークスペース管理者は、Data Studio の設定ページでワークスペースの必須コードレビューを有効にできます。
必須コードレビューが無効の場合でも、タスクをレビューに提出できますが、その結果は公開プロセスをブロックしません。
ノードの削除 操作はコードレビューをトリガーしません。
セキュリティ設定およびその他への移動
DataWorks コンソールの ワークスペース ページに移動します。上部ナビゲーションバーで目的のリージョンを選択し、目的のワークスペースの 操作 列で を選択します。
コードレビューの有効化
セキュリティ設定およびその他 タブで、 を有効にします。
コードレビューを強制 スイッチが セキュリティ設定およびその他 タブに表示されない場合は、DataWorks のエディションを確認してください。コードレビューは DataWorks Professional Edition 以降でのみ利用可能です。
パラメーター | 説明 |
コードレビューを強制 | ワークスペース内のタスクを本番環境に公開する前にコードレビューを必須とするかどうかを指定します。 |
コードレビュアー | コードをレビューできるユーザーを指定します。
説明
|
コードレビューのベースライン範囲 | 提出時にコードレビューを必須とするノードを設定します。 ノードが属するベースラインの優先度に基づいて、必須コードレビューの対象となるノードを決定できます。ロジックは以下のとおりです。
説明 非ベースラインタスクを選択すると、ワークスペース内のすべての新規ノードが承認を必要とすることを意味します。 |
コードレビューの通知方法 | 必須コードレビューを有効にした後、関係者に自動的に通知する設定が可能です。
以下の通知方法がサポートされています：SMS、DingTalk グループロボット Webhook、メール、WeCom グループ Webhook、Lark Webhook、および 汎用 Webhook。 コードレビューによって生成される SMS および電話アラートは、アラートリソース使用量に計上されます。コードレビューモジュールのアラートリソース使用量は、管理コンソールの アラートリソース ページで確認できます。詳細については、「アラートリソースの確認と設定」をご参照ください。 説明
|
イニシエーター向け：コードレビューの提出
ノードを提出するとコードレビューがトリガーされます。1 人以上のレビュアーを選択すると、レビュー依頼が生成されます。必須コードレビューが有効になっている場合、レビューが承認されるまで公開はブロックされます。
ノードに対してすでにコードレビューが進行中の場合、新しいレビューを提出すると、以前のレビューは自動的にキャンセルされます。
ノードの削除操作はコードレビューをトリガーしません。
タスクを公開します。
公開したい Data Studio ノードを保存するには
アイコンをクリックし、次に 
アイコンをクリックして 公開 ページに移動します。本番環境へのデプロイメントを開始 をクリックして公開します。必須コードレビューが有効になっているため、コードレビューが承認されるまで公開はブロックされます。
コードレビューを提出します。
コードレビューを提出 をクリックします。コードレビュー 構成ページで、コードレビュアー および 変更内容の説明 を構成します。
パラメーター
説明
コードレビュアー
コードレビュアー として構成されたユーザー一覧から、1 人以上のレビュアーを選択します。
変更内容の説明
コードの変更内容を記述します。
レビューの構成後、確認 をクリックして提出します。
レビュアー向け：レビュー依頼の処理
レビュアーは、 タブで、保留中のレビュー依頼を表示および処理できます。
コードレビューのページに移動します。
Data Studio ページの左側ナビゲーションウィンドウで
アイコンをクリックして コードレビュー一覧 ページを開きます。自分に割り当てられたレビュー依頼は 自分に割り当てられたレビュー に表示されます。レビュー依頼を処理します。
ページで、コードレビューの詳細を表示し、レビュー依頼に対して操作を実行できます。
コードレビュー一覧ページ上：レビュー依頼に対して迅速に操作を実行できます。例：承認、拒否、破棄、再開、および 共有。
コードレビュー詳細ページ上：
コードレビュー一覧 ページでレビュー依頼をクリックすると、コードレビュー詳細 ページに移動します。詳細ページでは、コードおよびスケジューリング構成の変更内容を本番バージョンと比較できます。この比較をもとに、レビューを承認するかどうかを判断します。
レビュー操作セクションでは、レビュアーはレビュー依頼に対して以下の レビュー操作 を実行できます。
：承認
：拒否
：破棄
：再開コメント。
説明破棄：現在のレビュー処理をキャンセルします。レビューが破棄された後、公開プロセスは、イニシエーターが新しいレビューを提出するか、このレビューを再開するまでブロックされたままになります。
再開：破棄されたレビュー処理を再度レビューする必要がある場合は、再開 をクリックします。
コードレビューが完了すると、イニシエーターは コードレビュー一覧 ページでレビューの詳細を表示し、レビュー依頼を管理できます。
イニシエーター向け：レビュー結果の確認
イニシエーターは、 タブで、レビュー結果を確認し、レビュー依頼を管理できます。
コードレビューのページに移動します。
Data Studio ページの左側ナビゲーションウィンドウで
アイコンをクリックしてコードレビューのページに移動します。自分が作成したレビュー でレビュー依頼を確認できます。レビュー結果を確認します。
ページで、コードレビューの詳細を表示し、依頼を管理できます。
コードレビュー一覧ページ上：イニシエーターはレビュー依頼の結果を迅速に確認し、破棄、再開、または 共有 などの操作を実行できます。
説明レビューを破棄した場合、公開プロセスを継続するには、新しい依頼を提出するか、破棄された依頼を再開する必要があります。
コードレビュー詳細ページ上：コードレビュー一覧 ページでレビュー依頼をクリックすると、コードレビュー詳細 ページに移動します。その後、コードレビューを 再開 または 破棄 するかどうかを決定できます。
レビューが拒否された場合、ノードを公開できません。レビューのフィードバックに従ってコードを修正し、再度レビューに提出する必要があります。レビューが承認された後でのみ、ノードを公開できます。
次のステップ
コードレビューが承認された後は、公開プロセスを継続できます。拒否された場合は、レビューコメントに基づいてコードを修正し、再度コードレビューに提出してください。