コードレビュー - DataWorks - Alibaba Cloud ドキュメントセンター

コードレビューは、デプロイメント前に本番コードが品質基準を満たしていることを確認します。必須レビューを有効にすると、タスクを本番環境に公開する前に承認が必要になります。

機能紹介

必須のコードレビューを有効にすると、非準拠のコードによるタスクの失敗を防ぎ、計算リソースの浪費を回避できます。有効にすると、レビュー担当者はコードが本番環境に到達する前にコードの品質を検証します。

必須のコードレビューが無効になっている場合: ノードを送信するときに手動でレビューを開始できます。ノードはレビューのステータスに関係なく公開できます。
必須のコードレビューが有効になっている場合: ノードを送信するときは、コードレビューを実行してコードの品質を確保するために、資格のあるレビュー担当者を選択する必要があります。
- 承認された場合は、ノードを公開できます。
- 拒否された場合は、フィードバックに基づいてコードを修正し、レビューのために再送信する必要があります。承認後にのみ公開できます。

制限事項

DataWorks Professional Edition 以上が必要です。詳細については、「DataWorks のエディション」をご参照ください。
Alibaba Cloud アカウント、ワークスペースの管理者、および AliyunDataWorksFullAccess 権限を持つ RAM ユーザーのみがコードレビューを有効または無効にできます。詳細については、「ユーザー、ロール、および権限」をご参照ください。
コードレビューは、特殊なノードタイプ (ループ、走査) または Python 以外のリソースファイルではサポートされていません。

(オプション) 管理者: 必須のコードレビューを有効にする

ワークスペース管理者は、Data Studio の設定ページでワークスペースの必須コードレビューを有効にできます。

説明

無効にすると、レビューは引き続き開始できますが、公開はブロックされません。
ノードを削除してもコードレビューはトリガーされません。

セキュリティ設定およびその他ページに移動

DataWorks コンソールのワークスペースページに移動します。上部のナビゲーションバーで、目的のリージョンを選択します。目的のワークスペースを見つけ、[操作] 列で [ショートカット] > [Data Studio] を選択します。
Data Studio の設定ページに移動します。
1. 左下隅のアイコンをクリックし、[Data Studio 設定] を選択します。
2. DataStudio 設定ページで、[セキュリティ設定およびその他] タブをクリックします。

コードレビューを有効にする

[セキュリティ設定およびその他] タブで、[コードレビューを強制] を有効にします。

重要

コードレビュー機能は、DataWorks Professional Edition 以上でのみ利用可能です。

パラメーター	説明
コードレビューを強制	タスクを本番環境に公開する前にコードレビューを要求します。
コードレビュー担当者	ワークスペース内のコードをレビューできるユーザーを指定します。任意の開発者ロール: 開発者ロールを持つ任意のユーザーをレビュー担当者として選択します。パブリッシャーは送信時に特定のレビュー担当者を選択します。開発ロールユーザーを指定: 公開前に指定された開発者からの承認が必要です。説明現在のワークスペースで開発者ロールを持つユーザーのみをレビュー担当者として選択できます。 1 人以上のレビュー担当者を設定します。複数のレビュー担当者が割り当てられている場合、いずれか 1 人からの承認で十分です。
コードレビューのベースライン範囲	送信時にレビューが必要なノードを指定します。所属するベースラインの優先度に基づいて、どのノードに必須のコードレビューが必要かを指定できます。ロジックは次のとおりです: ベースラインレビューの範囲を非ベースラインタスクに設定すると、ワークスペースで新しく作成されたタスクには承認が必要になります。特定のベースラインレベルに設定すると、そのレベルのノードには承認が必要になります。値が大きいほど優先度が高くなります。ベースラインタスクは非ベースラインタスクよりも優先されます。説明非ベースラインタスクを選択すると、ワークスペースで作成されたすべての新しいノードに承認が必要になります。
DingTalk グループロボット Webhook	カスタムの DingTalk チャットボットの Webhook URL を入力して、レビューのステータス通知を受信します。詳細については、「カスタムチャットボットを設定する」をご参照ください。説明 DingTalk グループチャットボットのセキュリティ設定では、キーワードを設定する必要があり、キーワードには `DataWorks` を含める必要があります。
コードレビューで @everyone を使用しますか？	有効にすると、ステータスの変更時に `(@)` ですべてのグループメンバーにメンションします。

レビュー開始者: コードレビューを開始する

ノードを送信すると、コードレビューがトリガーされます。レビュー担当者を選択して、レビューリクエストを生成します。必須レビューが有効になっている場合、承認されるまで公開はブロックされます。

説明

新しいレビューを開始すると、進行中のレビューは自動的に無効になります。
ノードを削除してもコードレビューはトリガーされません。

タスクを公開します。
1. アイコンをクリックしてノードを保存し、アイコンをクリックして公開ページを開きます。
2. [本番環境へのデプロイメントを開始] をクリックします。必須レビューが有効になっている場合、承認されるまで公開はブロックされます。
レビューのために送信します。
[コードレビューのために送信] をクリックします。レビュー担当者を選択し、変更内容を説明します。
設定項目
説明
コードレビュー担当者
設定されたリストから 1 人以上のレビュー担当者を選択します。
変更内容の説明
変更内容を説明します。
[確認] をクリックして送信します。

レビュー担当者: レビューリクエストを処理する

レビュー担当者は、[コードレビューリスト] > [自分がレビュー] でリクエストを表示および処理できます。

コードレビューページに移動します。
Data Studio の左側のナビゲーションウィンドウで、アイコンをクリックして、[自分がレビュー] の下にあるレビューキューにアクセスします。
レビューしてアクションを実行します。
リクエストの詳細と利用可能なアクションを表示します。
- コードレビューリストページで、リクエストをすばやく [承認]、[拒否]、[破棄]、[再開]、または [共有] します。
- コードレビュー詳細ページで:
  - コードとスケジュールの変更を本番環境と比較して、承認を決定します。
  - 利用可能なアクション:
    - : 承認。
    - : 拒否。
    - : 破棄。
    - : 再開。
    - [コメント]。

説明

破棄: レビューをキャンセルし、即時公開を許可します。
再開: 破棄されたレビューを再開します。

完了後、開始者は結果を表示し、リクエストを管理できます。

レビュー開始者: 結果を表示する

[コードレビューリスト] > [自分が作成] でレビュー結果を表示します。

コードレビューページに移動します。
Data Studio の左側のナビゲーションウィンドウで、アイコンをクリックして、[自分が作成] の下にあるレビューキューにアクセスします。
レビューのステータスを確認します。
詳細を表示し、必要に応じてアクションを実行します。
- コードレビューリストページで、結果を表示し、リクエストを [破棄]、[再開]、または [共有] します。
  説明
  破棄した後、レビューのために再送信するか、リクエストを再開して公開を続行します。
- コードレビュー詳細ページで、リクエストをクリックして詳細を開き、再開するか破棄するかを決定します。
拒否された場合は、フィードバックに基づいてコードを修正し、再送信します。承認後にのみ公開できます。

その他の操作

承認後、タスクを本番環境に公開します。拒否された場合は、フィードバックに基づいて修正し、再送信します。

設定項目	説明
コードレビュー担当者	設定されたリストから 1 人以上のレビュー担当者を選択します。
変更内容の説明	変更内容を説明します。