レビューのクリーンアップ

このセクションでは、レビューのクリーンアップ用に設定する構成可能変数について説明します。

Swarmでレビューを作成すると、そのレビュー専用のチェンジリストが作成されます。ユーザのチェンジリストは変更されないため、ユーザが現在行っている作業には影響しません。 新しい作業内容をレビューにサブミットするたびに、Swarmによって新しいチェンジリストが作成されるため、レビューのバージョン付き履歴が生成されることになります。

最終的にコミットしたレビューが、Swarm専用のコミット済みチェンジリストになります。 Swarmのチェンジリストは、通常はユーザに対して非表示になりますが、ユーザのチェンジリストは開いたままになります。 デフォルトでは、レビューの完了後に、ユーザが自分のチェンジリストを整理して削除する必要があります。

レビューのコミット時に自動的にこの処理を実行するためのオプションが用意されています。 このオプションの設定は、SWARM_ROOT/data/config.phpファイルのreviewsブロックに記述されています。以下に例を示します。

<?php
    'reviews' => array(
        'cleanup'              => array(
            'mode'        => 'user', // auto - follow default, user - present checkbox(with default)
            'default'     => false,  // clean up pending changelists on commit
            'reopenFiles' => false,   // re-open any opened files into the default changelist
        ),
    ),

このオプションはデフォルトで有効になっていますが、デフォルトの場合、クリーンアップは実行されません。そのため、レビューのコミット時にチェンジリストをクリーンアップする場合は、ユーザがこのオプションを選択する必要があります。

Swarmを使用するように設定されているHelixサーバのsuperユーザは、特定のレビューに関連するすべてのユーザのチェンジリストをクリーンアップすることができます。 それ以外のユーザの場合、レビューをコミットしたユーザであれば、自分が所有しているチェンジリストのみクリーンアップすることができます。

デフォルトでは、コミット操作を実行したユーザが所有しているチェンジリストのみがSwarmによってクリーンアップされます。 あるユーザがコミットしているレビューに他の複数のユーザが参加している場合、それらのユーザのチェンジリストがクリーンアップされることはありません。

コミット操作を実行するユーザが所有しているチェンジリストかどうかにかかわらず、特定のレビューに関連するすべてのチェンジリストをクリーンアップするようにSwarmを設定するには、Swarmで設定されているsuper権限をHelixサーバユーザに割り当てる必要があります(Swarmの他の操作の場合はadmin権限で実行できますが、この操作の場合はsuper権限が必要になります)。

• mode

  userモードの場合、レビューのコミット時にチェックボックスが表示されます。このチェックボックスを使用して、チェンジリストをクリーンアップするかどうかを選択することができます。

  autoモードの場合、チェックボックスは表示されません。コミットされたレビューがすべてクリーンアップされるか、いずれのレビューもクリーンアップされないという動作になります。どちらの動作になるかは、defaultの値によって異なります。

• デフォルト

  userモードに設定されている場合、defaultの値により、コミット時に表示されるチェックボックスをデフォルトでオンにするかどうかが決まります。

  autoモードに設定されている場合、defaultの値により、自動的に実行される操作が決まります。 この値をtrueに設定すると、チェンジリストが常にクリーンアップされ、falseに設定すると、クリーンアップは実行されません。

• reopenFiles

  チェンジリストのファイルがチェックアウトされている場合(保留されていない場合)、そのチェンジリストを削除することはできません。 reopenFilesをtrueに設定すると、チェンジリストのクリーンアップ時に、作業中のファイルが最初にデフォルトのチェンジリストに移動されるため、チェンジリストを削除できるようになります。

  値をfalseに設定した場合、チェックアウトされたファイルが含まれているチェンジリストはクリーンアップされません。

  通常は、ファイルを保留状態にした後で、それらのファイルを元に戻すという順序になりますが、その場合はこのオプションを使用する必要はありません。 値をtrueに設定すると、ユーザのデフォルトのチェンジリスト内に予期しないファイルが表示される場合があります。

レビューのクリーンアップ機能の目的は、ユーザのワークスペースを整理された状態に保ち、承認済みレビューのコミット後に、不要なチェンジリストが拡散するのを防ぐことです。

ただし、必ずしもこの機能が完璧に動作するわけではありません。ユーザの側から見た場合、この機能は自動的に実行されるため、ユーザが予期しない結果になることがあります。 この機能を使用する場合は、以下の点に注意してください。

• Swarmによって作成されたチェンジリストがこの機能で処理されることはありません。 レビュー履歴のレコードは常に保存されます。
• 通常は、レビューをコミットするユーザと作業を行うユーザは異なりますが、その場合は、superユーザとしてSwarmを実行しない限り、ほとんどのチェンジリストはクリーンアップされません。
• コミット操作を実行するユーザが作成したチェンジリストは削除されますが、 それ以外のユーザが作成したチェンジリストは削除されません。
• ユーザがチェンジリスト内でファイルを保留状態にし、それらのファイルを元に戻さなかった場合、それらのファイルは、そのユーザのローカルワークペース内に残ったままになるため、手動でクリーンアップする必要があります。