レビューの表示

レビュー担当者は、レビューインタフェースを使用して、コードレビューのほとんどの作業を行います。

ストリームのプライベート編集機能を使用すると、ワークスペース内のストリーム仕様をSwarmで使用することができます。チェンジリストやレビューにストリーム仕様が含まれている場合、[ファイル]タブの先頭にそのストリーム仕様が表示されます。このストリーム仕様には、「stream: //」というプレフィックスが付加されます。例えば、「stream://MyStreamDepotName/MyStreamSpecLocationName」などのように表示されます。レビューとチェンジリストに含めることができるストリーム仕様はそれぞれ1つだけです。

レビューインタフェースは、チェンジリストインタフェースと非常によく似ています。機能的にはほとんど同じですが、以下の各セクションで説明する点が異なっています。

レビューID

レビューIDは、Swarmレビューを特定するための一意の番号です。現在表示中のレビューのリビジョンと使用可能なリビジョンの総数が、括弧内に表示されるようになりました。

[プロジェクトの更新]ボタン

レビューが作成または更新されると、Swarmにより、レビューファイルが関連付けられているプロジェクトが確認され、そのプロジェクトにレビューがリンクされます。その後、新しいプロジェクトを作成したり、プロジェクトに新しいブランチを追加した場合、Swarmは、既存のレビューが新しいプロジェクトや新しいプロジェクトブランチに関連付けられているかどうかを確認することはありません。

[プロジェクトの更新]ボタンを使用すると、レビューが最後に更新された後で作成または更新されたプロジェクトにレビューファイルが関連付けられているかどうかを確認することができます。レビューに関連付けられていないプロジェクトが見つかった場合は、そのプロジェクトにレビューがリンクされます。

[変更を追加]ボタン

レビューが開始されると、そのレビューにチェンジリストを追加できるようになります。既存のレビューにチェンジリストを追加すると、便利な場合があります。例えば、レビュー内のファイルを後から変更する場合や、複数のチェンジリストを1つのレビューとしてグループ化する場合は、既存のレビューにチェンジリストを追加すると便利です。

既存のレビューにチェンジリストを追加するには、レビューヘッダの[変更を追加]ボタンを使用します。レビューのワークフロールールによって変更できないように保護されているレビューの場合、このボタンは表示されません。[終了状態のレビューの更新時]ルールの詳細については、「ワークフロールール」を参照してください。

[変更を追加]ドロップダウンメニューで使用できるオプションは、対象となるレビューがプリコミットレビューなのかポストコミットレビューなのかによって異なります。

• プリコミットレビューの場合:
  • 作業中チェンジリストを追加: 作業中チェンジリストをレビューに追加すると、そのチェンジリスト内のファイルが、レビュー内の既存のファイルに追加されます。詳しくは、「作業中チェンジリストをレビューに追加する」を参照してください。
  注意

  レビューに含めることができるストリーム仕様は1つだけです。ストリーム仕様が含まれているチェンジリストを、既にストリーム仕様が含まれているレビューに追加すると、チェンジリスト内のストリーム仕様によってレビュー内のストリーム仕様が置き換えられます。チェンジリスト内のストリーム仕様とレビュー内のストリーム仕様が異なっている場合、Swarmでその差異を表示することはできません。この場合、「ファイルの内容は変更されていません」という内容のメッセージが表示されます。

  • 作業中チェンジリストで置き換える: 作業中チェンジリストをレビューに追加すると、そのチェンジリスト内のファイルにより、レビュー内のすべてのファイルが置き換えられます。詳しくは、「作業中チェンジリストでレビューを置き換える」を参照してください。
  • コミット済みチェンジリストで置き換える: コミット済みチェンジリストをレビューに追加すると、そのチェンジリスト内のファイルにより、レビュー内のすべてのファイルが置き換えられます。詳しくは、「コミット済みチェンジリストでレビューを置き換える」を参照してください。
  注意

  コミット済みチェンジリストでプリコミットレビューを置き換えると、そのレビューの新しいバージョンとして、ポストコミットレビューが作成されます。

• ポストコミットレビューの場合:
  • 作業中チェンジリストで置き換える: 作業中チェンジリストをレビューに追加すると、そのチェンジリスト内のファイルにより、レビュー内のすべてのファイルが置き換えられます。詳しくは、「作業中チェンジリストでレビューを置き換える」を参照してください。
  注意

  作業中チェンジリストでポストコミットレビューを置き換えると、そのレビューの新しいバージョンとして、プリコミットレビューが作成されます。

  • コミット済みチェンジリストで置き換える: コミット済みチェンジリストをレビューに追加すると、そのチェンジリスト内のファイルにより、レビュー内のすべてのファイルが置き換えられます。詳しくは、「コミット済みチェンジリストでレビューを置き換える」を参照してください。

[.zipをダウンロード]ボタン

レビュー内のすべてのファイルが格納されるZIP形式のアーカイブファイルをダウンロードするには、[.zipをダウンロード]ボタンを使用します。ダウンロードしたファイルのバージョンは、レビューリビジョンセレクタで選択した最新のレビューリビジョンになります。詳しくは、「レビューのリビジョンを選択して表示する」を参照してください。

[.zipをダウンロード]ボタンをクリックすると、Swarmによって以下の手順が実行されます。

1. ファイル/フォルダのスキャン:
   • Helix Coreサーバの保護設定に従い、操作を実行するユーザが、ファイルやフォルダ内のコンテンツに対する権限を持っているかどうかを確認します。
   • ファイル全体のサイズがSwarmで処理可能なサイズであるかどうかを確認します。
2. Helix Coreサーバで、ファイルのコンテンツをSwarmサーバに対して同期します。
3. ファイルのコンテンツを圧縮してZIP形式のアーカイブファイルを作成します。
4. 生成されたZIPアーカイブファイルのダウンロードを開始します。

展開ステータス

プロジェクトに対して自動展開が構成されている場合、展開が成功したことを示すインジケータ または展開が失敗したことを示すインジケータ がレビューのヘッダに表示されます。展開処理の詳細を参照するURLを展開プログラムで提供できる場合、このインジケータがリンクになります。このインジケータをクリックすると、展開処理の結果が表示されます。

テストステータス

テストが設定されているワークフローがレビューに関連付けられている場合や、プロジェクトに対して継続的インテグレーションが設定されている場合、Swarmにより、レビューリビジョンの現在のテストステータスがレビューヘッダに表示されます。

• [テスト進行中]ステータスは、レビューリビジョンに対するいずれかのテストが実行されている場合、またはいずれの[オンデマンド]テストも実行されなかった場合に表示されます。
• [テストにパス]ステータスは、レビューリビジョンに対するすべてのテストにパスした場合に表示されます。
• [テストにパスしなかった]ステータスは、レビューリビジョンに対するいずれかのテストにパスしなかった場合に表示されます。

レビューリビジョンに関連付けられているテストの実行情報を表示するには、[テストステータス]をクリックしてドロップダウンリストを開きます。

継続的インテグレーションシステムがURLを使用してSwarmを呼び出すと、ドロップダウンリスト内のテストがそのURLにリンクされます。

ワークフローから呼び出されたテストのドロップダウンリストで、以下の操作を実行することができます。

• テストの再実行: テストの完了後にアイコンをクリックすると、最新バージョンのレビューに対してテストがもう一度実行されます。
• テストの実行: [オンデマンド]テストを実行するように設定されているテストがレビューワークフローに含まれている場合、アイコンをクリックすると、最新バージョンのレビューに対して手動でテストを実行することができます。

[レビュー状態]ボタン

[レビュー状態]ボタンをクリックすると、レビューの現在の状態が表示されます。このボタンを使用して、レビューの状態を変更することもできます。

レビューの状態に関する詳細と、レビューの状態を変更する方法については、「状態」と「レビュー状態の変更」を参照してください。

説明の編集

レビューの説明に表示される[説明の編集]アイコン をクリックして説明を編集することにより、レビュー時に行われた更新内容を反映することができます。

[作業中チェンジリストを更新]チェックボックス

説明を置き換えることができるのは、プリコミットレビューを編集する場合と、自分がそのレビューが作成されたチェンジリストの元の作成者である場合だけです。

[説明の編集]ダイアログで[作業中チェンジリストを更新]チェックボックスを選択すると、レビューの説明に対する変更内容が、元のチェンジリストの説明に適用されます。

タスク

コメントには、タスクフラグを設定することができます。タスクの操作方法については、「タスク」を参照してください。

タスクフラグが設定されたコメントの件数とステータスに関する要約が、コードレビューの説明の下に表示されます。タスクとしてフラグが立てられているコメントのうち、アーカイブされたものは表示されません。

タスクリストボタン()をクリックすると、レビューに関連するすべてのタスクを一覧表示するダイアログが開きます。

[タスク]ダイアログで、レポートユーザID(タスクを作成したユーザのユーザID)やタスクのステータスを使用して、タスクをフィルタリングすることができます。

• 作業状態のタスク(対応が必要なコメント)だけを表示するには、赤いフラグのボタンをクリックします。
• 対応済みのタスク(対応済みのコメント)だけを表示するには、緑のチェックマークのボタンをクリックします。
• 検証済みタスク(対応済みかつ検証済みのコメント)だけを表示するには、青い二重チェックマークのボタンをクリックします。

特定のタスクだけを表示するには、[タスク]ダイアログでそのタスクを選択して[表示]ボタンをクリックします。または、[タスク]ダイアログで、目的のタスクをダブルクリックすることもできます。この操作により、[タスク]ダイアログが終了し、Swarmによってレビューの表示内容が調整され、選択したタスクがビューに表示されます。

レビュー担当者

1人以上のレビュー担当者がレビューに割り当てられている場合や、自分がログインしている場合は、レビューの説明の下に[レビュー担当者]領域が常に表示されます。

この領域には、左から右の方向に、レビュー担当者編集ボタン 、現在の賛成票数と反対票数、現在のレビュー担当者グループのアバター、現在のレビュー担当者のアバターが表示されます。

レビュー担当者グループ

レビュー担当者グループのメンバーは、自分の個人アバターをクリックしてレビューに投票することができます。詳細については、「個々のレビュー担当者」を参照してください。メンバーの投票は、そのメンバーが属しているグループの投票として登録され、そのメンバーの個人アバターにも表示されます。各メンバーによるレビューの投票状況を表示するには、グループのアバターをクリックします。

以下に示すグループ設定を変更できるのは、レビューの作成者、プロジェクトメンバー、プロジェクトのモデレータ、super権限を持っているユーザだけです。

• 投票を任意にする:
  • いずれかのグループメンバーがレビューに対して反対票を入れた場合、そのグループがレビューに反対していることを示すバッジがグループアバターに表示されます。
  • 1人以上のグループメンバーがレビューに対して賛成票を入れ、それ以外のグループメンバーは反対票を入れなかった場合、そのグループがレビューに賛成していることを示すバッジがグループアバターに表示されます。
• 1つの投票を必須にする: 「1」を示す星形のバッジがグループアバターの上に表示されます。
  • いずれかのグループメンバーがレビューに対して反対票を入れた場合、そのグループがレビューに反対していることを示すバッジがグループアバターに表示されます。
  • 1人以上のグループメンバーがレビューに対して賛成票を入れ、それ以外のグループメンバーは反対票を入れなかった場合、そのグループがレビューに賛成していることを示すバッジがグループアバターに表示されます。詳細については、「必須レビュー担当者」を参照してください。
• すべての投票を必須にする: 星形のバッジがグループアバターの上に表示されます。
  • いずれかのグループメンバーがレビューに対して反対票を入れた場合、そのグループがレビューに反対していることを示すバッジがグループアバターに表示されます。
  • すべてのグループメンバーがレビューに対して賛成票を入れ、だれも反対票を入れなかった場合、そのグループがレビューに賛成していることを示すバッジがグループアバターに表示されます。詳細については、「必須レビュー担当者」を参照してください。
• レビューからグループを退出させる: グループがレビューから削除されます。

個々のレビュー担当者

個々のレビュー担当者がレビューに対して投票するたびに、その投票が賛成票なのか反対票なのかを示すバッジがそのレビュー担当者のアバターに表示されます。必須レビュー担当者のアバターには、星形のバッジが表示されます。

システムにログインして、他のメンバーが作成したレビューを表示すると、他のレビュー担当者のアバターの右側に自分のアバターが表示されます。自分のアバターの表示は、以下の条件に応じて変化します。

まだレビュー担当者になっていない場合、またはレビュー担当者グループのメンバーにはなっているがまだ投票していない場合: 自分のアバターをクリックすると、賛成票または反対票を投票するためのメニューが表示され、個人レビュー担当者として登録されます。投票せずに、個人レビュー担当者として直接レビューに参加することもできます。 レビュー担当者グループのメンバーが投票すると、そのメンバーも自動的に個人レビュー担当者として登録されます。	個人レビュー担当者になっているがまだ投票していない場合: 自分のアバターにバッジは表示されません。自分のアバターをクリックすると、メニューが表示されます。このメニューを使用して、賛成票または反対票を投票したり、自分の投票を必須にするかどうかを指定したり、レビューから退出したりすることができます。 レビュー担当者グループのメンバーでもある場合は、[レビューから退出]をクリックしても、引き続きレビュー担当者グループのメンバーとして登録されたままになります。
個人レビュー担当者としてすでに投票している場合、またはレビュー担当者グループのメンバーとしてすでに投票している場合: 自分のアバターに、自分の投票を示すバッジが表示されます。自分のアバターをクリックすると、メニューが表示されます。このメニューを使用して、自分の投票をクリアまたは変更したり、自分の投票を必須にするかどうかを指定したり、レビューから退出したりすることができます。 レビュー担当者グループのメンバーでもある場合は、[レビューから退出]をクリックすると、自分の投票はクリアされますが、引き続きレビュー担当者グループのメンバーとして登録されたままになります。	必須レビュー担当者になっている場合、またはすべてのメンバーが投票する必要があるレビュー担当者グループのメンバーになっている場合: 自分のアバターに星形のバッジが表示されます。このバッジは、自分が賛成票を入れない限りレビューは承認されないということを示しています。自分のアバターをクリックすると、自分の投票を変更するためのメニューオプション、自分の投票を任意にするかどうかを指定するメニューオプション、レビューから退出するためのメニューオプションが表示されます。 レビュー担当者グループのメンバーでもある場合は、[レビューから退出]をクリックしても、引き続きレビュー担当者グループのメンバーとして登録されたままになります。すべてのメンバーが投票する必要があるレビュー担当者グループのメンバーは、[自分の投票を任意にする]オプションを使用することはできません。

レビューの承認

以下の要件が満たされている場合に、レビューを承認することができます。 

• すべての必須レビュー担当者が、レビューに対して賛成票を入れた場合。
• レビューで設定されている[最小賛成票]の値が、そのレビューに関連するすべてのプロジェクトとブランチの要件を満たしている場合。

レビューを承認するには、[レビュー状態]ボタンを使用します。

古い投票

レビューを更新することにより、そのレビューのファイルリスト、ファイルのコンテンツ、またはファイルタイプが変更された場合、そのレビューに対するすべての投票が古い投票になります。その場合、投票のカウントがリセットされ、投票を示すバッジがミュート表示になります。

投票を示すバッジがミュート表示になっているレビュー担当者のアバターにマウスオーバーすると、そのレビュー担当者のユーザID、投票の内容、レビューのバージョンを示すツールチップが表示されます。レビューの各バージョンは、レビューのリビジョンを選択して表示する上のポイントとして表示されます。

通知機能を無効にする

レビューに参加した場合や、レビューの説明のコメント内で自分が@mentionされている場合は、そのレビューに関連付けられているイベントに関する通知を受け取ります。このままレビューには参加するが、通知は受け取りたくない場合は、以下の手順で通知機能を無効にすることができます。

1. レビュー担当者領域で自分のアバターをクリックし、レビュー担当者オプションを表示します。
2. [通知を無効にする]をクリックします。

通知機能を無効にすると、それ以降は通知が送信されることはありません。ただし、それ以降のレビューコメントで自分が@mentionされた場合は、そのコメントに関する通知を受け取りますが、通常の通知を受け取ることはありません。この方法により、他のレビュー担当者やレビュー作成者が重要だと考えていることを見落とすことがなくなります。

レビュー作成者を変更する

レビュー作成者の変更を許可するための構成オプションを有効にすると、タスクアイコンとレビュー担当者アイコンの左側に追加のアイコンが表示されます。このオプションは、デフォルトで無効になっています。有効にする場合は、Swarmの管理者に問い合わせてください。

作成者編集ボタン()が表示されている場合は、そのボタンをクリックすると、レビューの作成者を変更するためのダイアログが表示されます。元の作成者が有効ではなくなった場合や、レビューの所有権が別の開発者に渡された場合に、この機能を使用すると便利です。

レビューのリビジョンを選択して表示する

[ファイル]タブのファイルリスト上部にあるレビューリビジョンセレクタを使用して、差分 (名詞) 2つのファイル、または2つのストリームバージョンを比較したときに一致しない行セット。2つのファイルの差分と、ベースファイルとの差分が異なっている状態、または2つのストリームバージョンの差分が異なっている状態のことを、衝突といいます。 (動詞) ファイルまたはファイルリビジョンの内容を比較すること。またはストリームバージョンの内容を比較すること。 コンフリクトも参照してください。を表示するレビューのリビジョンを指定します。

• 左側のドロップダウンセレクタ: レビューのベースバージョンがデフォルトで選択されます。ベースバージョンとは、レビューに対して変更される前にディポからチェックアウトされたファイルのバージョンのことです。ディポ内の現行バージョン(最新リビジョン ディポ内のファイルの最新リビジョン。ファイルリビジョンには昇順で番号が割り振られるため、最新リビジョンはそのファイルで一番大きい番号の付いたリビジョンです。と呼ばれることがあります)を選択することができます。レビューのリビジョンが複数存在する場合は、特定のリビジョンを選択することができます。
• 右側のドロップダウンセレクタ: レビューの最新リビジョンがデフォルトで選択されます。レビューのリビジョンが複数存在する場合は、特定のリビジョンを選択することができます。

差分の表示方法については、「差分」を参照してください。

コメントフィルタボタン

多くのリビジョンとコメントが含まれているレビューの場合、それらのコメントで指摘された事項が対応済みであるかどうかを判断するのが難しいことがあります。そのような場合は、[コメントのフィルタ]ボタン()をクリックすると、現行バージョンのレビューに関するコメントだけを表示することができます。

[ファイル]タブ

ファイルリストのヘッダには、以下の情報が表示されます。

• レビューで使用されるファイルの現在のバージョン
• レビューで使用されるファイルの保留中のコピーが含まれているチェンジリスト
• レビューで使用されるすべてのファイルの共通パス

diffモードの場合、ファイルリストのヘッダには以下の情報が表示されます。

• 比較対象となる2つのレビューファイルのバージョン
• 比較対象のファイルが含まれているチェンジリスト
• レビュー内の両方のバージョンが存在するすべてのファイルの共通パス

[履歴]タブ

[履歴]タブには、現在のレビューに影響するイベントの一覧が表示されます。

例えば、以下のようなイベントが表示されます。

• レビューがいつ開始されたか
• 新しいレビュー担当者がいつレビューに参加したか
• レビューの状態がいつ変わったか
• レビューのファイルがいつ更新されたか
• レビュー担当者がいつレビューに対して投票したか
• レビュー担当者がいつレビューに対して(またはレビューのファイルに対して)コメントしたか
• テストがいつ成功または失敗したか(継続的な統合が構成されている場合)

ファイルを既読にする

レビュー内の各ファイルの横には、[ファイルを既読にする]ボタン()が表示されます。このボタンを使用して、レビュー済みのファイルを確認することができます。既読フラグの設定は、ユーザごとに個別に記憶されます。レビューを更新したことが原因でファイルの内容が変更された場合は、既読フラグが自動的にクリアされます。これは特に、コードレビューが多数のファイルで構成されている場合に役立ちます。

このボタンをクリックするとボタンの色が反転し、関連するファイルがミュート表示になるため、既読ファイルと未読ファイルを簡単に区別することができます。

ファイルが既読にされた場合、ボタンをもう一度押すとステータスがリセットされて未読になります。

Git Fusionで作成されたレビューを識別する

Git Fusionを使用して開始されたレビューの場合、メインのレビューIDの横にGitロゴが表示されます。HelixサーバユーザはGit Fusionを使用して開始されたレビューを更新することができないため、このロゴは重要です。