レビュー

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

作成者によるレビューの自己承認を無効にする

Swarm 2015.2リリースには、作成者によるレビューの自己承認を無効にする機能が導入されています。作成者がモデレータや管理者であっても、自己承認を無効にすることができます。この機能は、作成者以外のユーザによるレビューが重要な意味を持つ開発ワークフローで使用すると便利です。

作成者によるレビューの自己承認を無効にするには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'disable_self_approve' => true,
    ),

デフォルト値はfalseです。

1つのレビューが複数のブランチにまたがる場合のモデレータの動作

デフォルトでは、1つのレビューが、異なるモデレータが設定されている複数のプロジェクトブランチにまたがる場合、いずれかのブランチのモデレータだけが、レビューを承認する必要があります。各ブランチのいずれかのモデレータだけがレビューを承認できるようにするには、該当する構成可能変数をeachに設定します。レビューに関連する複数のブランチに属しているモデレータの場合、属している各ブランチについて、承認がカウントされます。

各ブランチのいずれかのモデレータだけがレビューを承認できるようにするには、SWARM_ROOT/data/config.phpファイルを編集用として開き、以下に示すコードブロック内のreviewsセクションで、moderator_approval構成可能変数をeachに設定します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'moderator_approval' => 'each', // 'any|each'
    ),

デフォルト値はanyです。

作業状態のタスクが含まれているレビューの承認を禁止する

Swarmのレビュー承認禁止機能が有効になっている場合、作業状態のタスクが含まれているレビューを承認したり、承認してコミットしたりすることはできません。作業状態のタスクが含まれているレビューを承認するには(または、承認してコミットするには)、最初に作業状態のタスクに対応してから、それらのタスクを[対応済みタスク]、または[タスクではない]に設定する必要があります。詳しくは、「[対応済みタスク]または[タスクではない]に設定する」を参照してください。

作業状態のタスクが含まれているレビューの承認とコミットを禁止するには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'disable_approve_when_tasks_open' => true,
    ),

デフォルト値はfalseです。この場合、作業状態のタスクに関する警告が表示されますが、承認操作とコミット操作が禁止されることはありません。

レビューの状態の保護

デフォルト設定の場合、レビューの状態に関係なく、レビューの内容を更新することができます。end_states構成可能変数を使用してレビューが特定の状態に設定されている場合、コンテンツの自動変更機能を使用してレビューを保護することができます。

ワークフロー:

• ワークフローが有効になっている場合(これがデフォルト設定です): end_states構成可能変数により、保護するレビュー状態が設定されます。[終了状態のレビューの更新時]ルールとワークフローを組み合わせて使用すると、保護されているレビューが含まれているプロジェクトとブランチを確認することができます。
• ワークフローが無効になっている場合:: レビューの内容を更新する際に、そのレビューが更新可能かどうかについて、end_states配列が確認されます。レビューの状態がend_states配列内の状態と一致している場合は、更新のサブミット操作が拒否されます。

保護するレビューの状態を設定するには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を挿入します。この例では、保護するレビューの状態として、[アーカイブ済み]、[却下]、[承認済み :コミット済み]が指定されています。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'end_states' => array('archived','rejected', 'approved:commit'),
    ),

配列内で指定できるレビューの状態を以下に示します。

• archived: レビューの状態は[アーカイブ済み]になります。
• rejected: レビューの状態は[却下]になります。
• approved:commit: レビューが承認されてコミットされた状態です。レビューの状態は、[承認済み :コミット済み]になります。
• approved: レビューの状態は[承認済み]になります。

デフォルトでは、配列は空になっています。この場合、レビューの状態に関係なく、レビューの内容を更新することができます。

Process_shelf_file_delete_when配列

デフォルトでは、保留状態のチェンジリストからファイルを削除しても、関連するレビューからそれらのファイルが削除されることはありません。

レビューの状態がprocess_shelf_delete_when配列で設定されている場合、シェルフからファイルを削除すると、Swarmによって以下の手順が自動的に実行されます。

1. シェルフがいずれかのレビューに関連付けられているかどうかが確認されます。
2. 上記のレビューの状態が、process_shelf_delete_when配列で設定されているレビューの状態に一致する場合は、削除したファイルがレビューから削除されます。

レビューが特定の状態になっていて、関連する保留状態のチェンジリストからファイルが削除された場合に、それらのファイルをレビューから削除するには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。この例では、レビューの状態として、[レビューが必要]と[リビジョンが必要]が指定されています。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'process_shelf_delete_when' => array('needsReview', 'needsRevision'),
    ),

配列内で指定できるレビューの状態を以下に示します。

• needsReview: レビューの状態は[レビューが必要]になります。
• needsRevision: レビューの状態は[リビジョンが必要]になります。
• rejected: レビューの状態は[却下]になります。
• approved: レビューの状態は[承認済み]になります。

この機能を無効にするには、以下のように配列を空にします。これが、配列のデフォルト設定です。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'process_shelf_delete_when' => array(),
    ),

作成者の変更を許可する

作成者変更機能が有効になっている場合、レビューの作成者を変更することができます。この機能は、元の作成者が無効になり、その所有権を他のメンバーが引き継ぐ必要がある場合に使用すると便利です。

レビューの作成者を変更できるようにするには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'allow_author_change' => true,
    ),

デフォルト値はfalseです。

作成者によるレビューの消去を許可する

レビュー消去機能が有効になっている場合、自分が作成したレビューを消去することができます。レビューの消去方法については、「レビューを消去する」を参照してください。

自分が作成したレビューを消去できるようにするには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'allow_author_obliterate' => true,
    ),

デフォルト値はfalseです。

レビューの説明を同期する

レビューの説明の同期機能を有効にすると、そのレビューに関連するチェンジリストの説明を更新することにより、レビューの説明を更新することができます。関連するチェンジリストを保存するたびに、レビューの説明がそれに合わせて更新されます。

レビューの説明の同期機能を有効にするには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'sync_descriptions' => true,
    ),

デフォルト値はfalseです。

展開するファイルの数を制限する

レビューページには、レビュー内のすべてのファイルを開くための[すべて展開]ボタンが用意されています。ファイルの数が多い場合にこのボタンをクリックすると、パフォーマンスが低下する可能性があります。

expand_all_file_limitオプションを使用して値を指定すると、レビュー内のファイルの数がその値を超えた場合に、[すべて展開]ボタンが無効になります。この値をゼロに設定すると、このボタンが常に有効になり、すべてのファイルを開くことができます。

[展開するファイルの数を制限する]オプションの制限値を変更するには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'expand_all_file_limit' => 10,
    ),

このオプションを指定しなかった場合のデフォルト値は10です。

グループレビュー担当者を展開する

デフォルトでは、レビュー担当者グループのメンバーが対話形式でレビューの作業を行う際に(投票、コメント、更新、コミット、アーカイブなど)、レビューページの[個人]領域にそのメンバーは表示されません。レビュー担当者グループのメンバー数が多い場合は、この動作により、個々のメンバーのアバターで[個人]領域がいっぱいになるのを防ぐことができます。

expand_group_reviewersをtrueに設定すると、レビュー担当者グループのメンバーが対話形式でレビューの作業を行う際に(投票、コメント、更新、コミット、アーカイブなど)、レビューページの[個人]領域にそのメンバーが追加されます。レビュー担当者グループの数が多い場合は、この設定により、パフォーマンスが低下する可能性があります。

グループレビュー担当者を展開するには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'expand_group_reviewers' => true,
    ),

デフォルト値はfalseです。

承認とコミットのテストを無効にする

追加のコンテキスト行

[レビューの表示]ページと[チェンジリストの表示]ページのファイル差分ビューでファイルを展開すると、[上記のコードの行をさらに表示]ボタンと[以下のコードの行をさらに表示]ボタンが表示されます。表示されているファイル内のコンテキスト行をさらに表示する場合は、これらのボタンを使用します。デフォルトでは、10行のコンテキスト行が追加で表示されます。

上記のボタンをクリックしたときに表示される行数を変更するには、SWARM_ROOT/data/config.phpファイルを編集用として開き、reviewsブロック内に以下の行を追加します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'more_context_lines' =>15, // defaults to 10 lines
    ),

このオプションを指定しなかった場合のデフォルト値は10です。

レビューの複雑度

レビューの複雑度は、レビューリストページの各レビューの[複雑度]列に表示されます。この列で、リスト内の各レビューの複雑度を簡単に確認することができます。デフォルト設定の場合、レビューの複雑度は、レビューファイル内で変更された行の数に基づき、高、中、低の3段階で表示されます。「高」複雑度と「低」複雑度の値は、high変数とlow変数を使用して設定します。

複雑度の値を変更するには、SWARM_ROOT/data/config.phpファイルのreviewsブロックを以下のように編集します。

<?php
    // this block should be a peer of 'p4'
    'reviews' => array(
        'statistics' => array(
            'complexity' => array(
                'calculation' => 'default', // 'default|disabled'
                'high' => 300,
                'low' => 30
            ),
        ),
    ),

• calculation
  • default: レビューファイル内で変更された行の数に基づいて、複雑度が計算されます。新しいファイルの場合は、そのファイル内の行数がカウントされます。デフォルト値は「default」です。
  • disabled: 複雑度の計算が無効になります。
• high:「高」複雑度として表示する場合の変更行数を整数で指定します。デフォルト値は300です。
• low:「低」複雑度として表示する場合の変更行数を整数で指定します。デフォルト値は30です。

デフォルト設定の場合、複雑度は以下のように計算されます:

• レビューファイル内の変更行数がhigh変数の値以上の場合は、複雑度として[高]が表示されます。
• レビューファイル内の変更行数がhigh変数の値よりも小さくてlow変数の値よりも大きい場合は、複雑度として[中]が表示されます。
• レビューファイル内の変更行数がlow変数の値以下の場合は、複雑度として[低]が表示されます。