強制コードレビュー機能は、ワークスペースに対してのみ有効にできます。ワークスペースに対して強制コードレビュー機能を有効にすると、ワークスペース内の開発者によってコミットされたノードコードは、コードレビューに合格した後にのみデプロイできます。ベースラインの優先順位に基づいて、コードレビューを開始するノードを指定できます。たとえば、優先順位の高いベースラインに属するノードに対してコードレビューを開始できます。このようにして、ノードは期待どおりに実行され、他のノードをブロックしません。このトピックでは、強制コードレビュー機能の使用方法について説明します。
前提条件
DataWorks Professional Edition 以上がアクティブ化されています。DataWorks Standard Edition、DataWorks Professional Edition、および DataWorks Enterprise Edition の機能の違いについては、DataWorks エディション間の違いをご参照ください。DataWorks をアクティブ化する方法については、購入ガイドをご参照ください。
[ワークスペース管理者] ロールが割り当てられています。詳細については、ユーザー、ロール、および権限の概要をご参照ください。
データ開発用にノードが作成されています。詳細については、DataStudioをご参照ください。
背景情報
DataWorks で複数のノードが並列実行される場合、優先順位の高いノードは優先的にリソースを使用できます。優先順位の高いノードが無効なノードコードが原因で実行に失敗した場合、ノードは長時間にわたってコンピューティングリソースを占有します。その結果、リソースが浪費され、他のノードの実行がブロックされる可能性があります。この問題を解決するには、優先順位の高いノードを特定のベースラインに追加し、そのベースラインに対して強制コードレビュー機能を有効にすることをお勧めします。このようにして、コードレビュー担当者はノードのコード品質を制御し、無効なノードコードが原因で発生するノード実行エラーを防ぐことができます。
次の表は、強制コードレビュー機能がノードのコミットおよびデプロイプロセスに与える影響について説明しています。
強制コードレビューの状態 | 説明 | 影響 |
無効 | ノードをコミットすると、DataWorks は指定されたコードレビュー担当者にノードの変更を通知します。 説明 ワークスペース内のすべてのメンバーは、ロールに関係なく、コードレビュー担当者として設定できます。 | ノードのコミットおよびデプロイプロセスは影響を受けません。ノードは正常にコミットおよびデプロイできます。 |
有効 | ノードをコミットするときは、コードの品質を管理するために、ノードのコードをレビューする資格のあるユーザーを指定する必要があります。 説明 ノードを削除した場合、ノードをコミットしてもコードレビューはトリガーされません。 | ノードのコミットおよびデプロイプロセスはブロックされ、ノードでコードレビューが実行されます。
|
制限事項
DataWorks Professional Edition 以上をご利用のユーザーのみが強制コードレビュー機能を使用できます。
[ワークスペース管理者] ロールが割り当てられているユーザーのみが、ワークスペースで強制コードレビュー機能を有効にするかどうかを決定できます。
一部の特殊なタイプのノードに対しては、コードレビューを開始できません。たとえば、do-while ノードや for-each ノードなどの複合ノード、または Python 以外のリソースファイルに対しては、コードレビューを開始できません。
手順
次の表は、強制コードレビュー機能を使用するための手順について説明しています。
手順 | 実行ロール | 説明 |
ワークスペース管理者 | ワークスペース管理者ロールが割り当てられているユーザーは、強制コードレビュー機能を有効にし、コードレビュー担当者を指定し、ビジネス要件に基づいてコードレビューの範囲を指定できます。強制コードレビュー機能は、機能が有効になった後にのみ有効になります。 説明 強制コードレビュー機能が有効になると、ノードのコミットおよびデプロイプロセスはブロックされます。 | |
開発者 | 開発者がノードをコミットすると、コードレビューがトリガーされます。開発者がコードレビュー担当者を指定すると、システムはコードレビューチケットを生成します。 説明 標準モードのワークスペースでは、開発者は[デプロイ] ページで複数のノードを選択し、一度にコードレビューを開始できます。詳細については、ノードのデプロイをご参照ください。 | |
| コードレビュー ページで、コードレビュー開始者はコードレビューを開始したノードを表示でき、コードレビュー担当者はレビューが必要なコードのノードを表示および処理できます。 |
強制コードレビュー機能を有効にし、パラメーターを設定する
DataWorks コンソールにログインします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションペインで、 を選択します。表示されたページで、ドロップダウンリストから目的のワークスペースを選択し、[データ開発に移動] をクリックします。
セキュリティ設定とその他タブに移動します。
DataStudio ページの左下隅にある
アイコンをクリックします。[設定] ページの個人設定タブが表示されます。[セキュリティ設定とその他] タブをクリックします。
強制コードレビュー機能を有効にし、パラメーターを設定します。
セキュリティ設定とその他タブの [コードレビュー] セクションで、[コードレビューを強制する] をオンにし、パラメーターを設定できます。コードレビュー担当者とコードレビューのベースラインスコープ。
パラメーター
説明
[コードレビューを強制する]
現在のワークスペース内の特定のノードに対して強制コードレビュー機能を有効にするかどうかを指定します。スイッチをオンにすると、ノードをコミットしたときにコードレビューがトリガーされます。
[オン]: 現在のワークスペース内の特定のノードをコミットするときに、コードレビュー担当者を指定する必要があります。ノードコードは、コードがコードレビューに合格した後にのみデプロイできます。強制コードレビュー機能が有効になっている場合、ノードのコミットおよびデプロイプロセスはブロックされます。
説明[コードレビュー担当者] パラメーターと [コードレビューのベースラインスコープ] パラメーターは、[コードレビューを強制する] をオンにした後にのみ設定できます。
[オフ]: 現在のワークスペースでコミットするノードのコードは、コードレビューなしでデプロイできます。コミットするノードを選択するときに、コードレビュー担当者を指定できます。ノードをコミットした後、指定されたコードレビュー担当者にはノードの変更のみが通知され、ノードのコミットおよびデプロイプロセスはブロックされません。
コードレビュー担当者
ノードをコミットするときにコードレビューに使用できるユーザー。
[任意の開発者ロール]: このオプションを選択すると、現在のワークスペースで開発ロールが割り当てられているすべてのユーザーが、ノードをコミットするときにコードレビューに使用できます。ノードをコミットするときは、ノードコードをレビューする特定のユーザーを選択する必要があります。
[開発ロールユーザーを指定する]: このオプションを選択すると、この手順で特定のユーザーをコードレビュー担当者として指定する必要があります。デフォルトでは、指定されたユーザーは現在のワークスペース内のノードのコードレビュー担当者です。
説明現在のワークスペースで開発ロールが割り当てられているユーザーのみをコードレビュー担当者として選択できます。
DataWorks では、1 人以上のコードレビュー担当者を設定できます。この手順で [任意の開発者ロール] を選択し、ノードをコミットするときに複数のコードレビュー担当者を設定した場合、コードレビュー担当者のいずれかがコードを承認すると、ノードコードはコードレビューに合格します。[開発ロールユーザーを指定する] を選択し、この手順で複数のコードレビュー担当者を設定した場合、すべてのコードレビュー担当者がコードを承認した後にのみ、ノードコードはコードレビューに合格します。
[コードレビューのベースラインスコープ]
ノードをコミットするときにコードレビューを実行するノードのスコープ。
ノードが属するベースラインの優先順位に基づいて、コードレビューを実行するノードを決定できます。
このパラメーターを [ベースライン以外のタスク] に設定すると、現在のワークスペースに新しく作成されたノードでコードレビューが実行されます。
このパラメーターを 1 つ以上の特定レベルのベースラインタスクに設定すると、現在のワークスペースで特定の優先順位のベースラインに属するノードでコードレビューが実行されます。
ベースラインタスクレベルの値が大きいほど、優先順位が高くなります。ベースライン内のノードは、ベースラインにないノードよりも優先順位が高くなります。
ベースラインを使用してノードの優先順位を制御する方法の詳細については、概要をご参照ください。
ノードのコードレビューを開始する
DataWorks では、開発者がノードをコミットするときに、1 人以上のコードレビュー担当者を指定できます。次の表は、さまざまなモードのワークスペースのコードレビュープロセスについて説明しています。
以前のコードレビューがコードに対して実行されているときにノードのコードレビューを再度開始すると、以前のコードレビュー結果は無効になります。
ノードを削除した場合、ノードをコミットしてもコードレビューはトリガーされません。
ワークスペースモード | コードレビュープロセス | コードレビューエントリ |
[標準モード] | 強制コードレビュー機能が有効になっている場合、ノードコードがコードレビューに合格するまで、ノードのコミットおよびデプロイプロセスはブロックされます。ノードコードがコードレビューに合格すると、ノードはコミットされ、[デプロイ] ページでノードをデプロイできます。 |
|
[基本モード] | 強制コードレビュー機能が有効になっていて、ノードをコミットするときに表示されるダイアログボックスで [コードレビューのみを開始する] をクリックした場合、ノードコードがコードレビューに合格した後に、[送信] を再度クリックして本番環境にノードをコミットする必要があります。 |
|
コードレビューチケットを表示および処理する
コードレビュー ページに移動します。
次のいずれかの方法でコードレビュー ページに移動できます。
DataStudio ページの左上隅にある
アイコンをクリックし、 を選択します。ノードの設定タブで、上部ツールバーにある
アイコンをクリックします。
コードレビューチケットを表示および処理します。
コードレビュー ページで、開始したコードレビューのノードと、レビューが必要なコードのノードを表示できます。ビジネスシナリオに基づいてノードのコードをレビューできます。
領域
説明
1
この領域では、次の操作を実行できます。
コードレビュー担当者は、[私がレビュー] ページで、レビューが必要なコードのノードを表示および処理できます。
コードレビュー開始者は、[私が送信] ページで、コードレビューを開始したノードを表示できます。
2
この領域では、コードレビューの状態、ノード名、ノードタイプ、コードレビュー開始者、ノードコミット時間などの指定されたフィルター条件を満たすノードを検索できます。
3
この領域では、ノードのバージョンやコードレビューの状態などの基本情報を表示できます。また、ノードの詳細を表示し、ノードを処理することもできます。
次の操作を実行できます。
バージョン比較: さまざまなバージョンのノードコードを比較することで、ノードの変更を確認できます。
コードレビューチケットの処理:
[コメントを書く]: ノードバージョンにコメントを追加できます。
[合格]: コードレビューチェッカーをトリガーしてノードのコードをチェックします。ノードコードがコードレビューに合格すると、コードレビュー開始者は [デプロイ] ページでノードをデプロイできます。
説明ノードをデプロイする方法の詳細については、ノードのデプロイをご参照ください。
[不合格]: 現在のワークスペースで [コードレビューを強制する] がオンになっているかどうかによって、ノードが処理されます。スイッチがオンになっている場合、ノードのコミットおよびデプロイプロセスはブロックされます。スイッチがオフになっている場合、ノードはコミットおよびデプロイできます。
[破棄]: 現在のコードレビュープロセスは破棄されます。コードレビュープロセスが破棄されると、現在のバージョンのノードは引き続きコミットおよびデプロイできます。
[再開]: 破棄されたコードレビュープロセスが [再開] されます。