ワークフローの追加

ワークフローを追加するには、以下の手順を実行します。

1. Swarmの[ワークフロー]ページで、[+ ワークフローを追加]ボタンをクリックします。

   [ワークフローを追加]ページが表示されます。

    

   
2. ワークフローの名前を入力します。
3. 任意: ワークフローの説明を入力します。

4. 自分がワークフローの所有者として自動的に追加されます。

   任意: 必要に応じて、自分以外の所有者を追加します。このフィールドに文字を入力すると、Helixサーバ内でその文字に一致するグループやユーザが自動的に表示されます(グループとユーザの組み合わせで最大20件)。

   重要

   • 1つのワークフローにつき、1人以上の所有者が必要です。
   • 所有者である自分自身をワークフローから削除すると、super ユーザ権限を持っていない限り、このワークフローの設定を編集できなくなります。

5. 任意: 自分が所有しているワークフローを他のSwarmユーザも使用できるようにするには、[他のユーザと共有済み]チェックボックスを選択します。

   ヒント

   ワークフロールールが正しく機能することが確認できない場合は、このチェックボックスを選択しないでください。このチェックボックスを選択するまで、自分が所有するワークフローを他のSwarmユーザが使用することはできません。ワークフローに問題がないことを確認してからこのチェックボックスを選択して、他のユーザとワークフローを共有してください。

6. ルール:

   レビューなしのコミット時:

   このルールは、レビューが関連付けられていないチェンジリストがSwarmの外部でサブミットされた場合に適用されます。

   以下に示すいずれかのオプションを選択します。

   • 許可: チェンジリストのチェック処理は実行されず、レビューがない状態でチェンジリストがサブミットされます。
   • レビューを作成: チェンジリストがサブミットされ、そのチェンジリストに対して自動的にレビューが作成されます。
   • 却下: チェンジリストのサブミットが却下されます。
   ヒント

   チェンジリストの説明内で#reviewキーワードを指定してチェンジリストをサブミットした場合も、選択したルールが適用されます。チェンジリストの説明内にキーワードを指定してレビューを作成する方法については、「レビューの作成」を参照してください。

   レビューありのコミット時: このルールは、以下の場合に適用されます。

   • Swarmレビューがコミットされた場合。
   • レビューが関連付けられているチェンジリストがSwarmの外部でサブミットされた場合。

   以下に示すいずれかのオプションを選択します。

   • 許可: チェンジリストのレビュー状態はチェックされません。関連付けられているレビューが承認されていない場合であっても、チェンジリストがコミットされます。
   • 承認済みでない場合は却下: 関連するレビューが承認済みで、チェンジリストの内容がそのレビューの内容と一致している場合にのみ、チェンジリストがサブミットされます。
   ヒント

   #review-nnnnn、#replace-nnnnn、#append-nnnnnのうち、いずれかのキーワードをチェンジリストの説明内で指定してそのチェンジリストをサブミットした場合も、選択したルールが適用されます(「nnnnn」はレビューID)。チェンジリストの説明内にキーワードを指定してそのチェンジリストをレビューに追加する方法については、「レビューにチェンジリストを追加する」を参照してください。

   終了状態のレビューの更新時:

   特定の状態になっているレビューの内容を自動的に変更されないように保護する場合は、このルールを使用します。デフォルトの場合、[アーカイブ済み]、[却下]、[承認:コミット]の状態になっているレビューが保護されます。保護対象となるレビューの状態は、Swarmの管理者が設定します。詳しくは、end_states構成可能変数に関する説明を参照してください。

   ヒント

   レビューが保護されている場合であっても、Swarm UIでそのレビューを手動で更新することができます。

   チェンジリストをレビューに追加すると、このルールが適用されます。

   以下に示すいずれかのオプションを選択します。

   • 許可: レビューはチェックされません。レビューの状態に関係なく、チェンジリストがレビューに追加されます。これが、デフォルトの設定です。
   • 却下: レビューの状態が、end_state構成可能変数で指定されたいずれかの状態に一致する場合、以下のような動作になります。
     • レビューの[変更を追加]ボタンが無効になります。
     • チェンジリストの説明内で、#review-nnnnn、#replace-nnnnn、または#append-nnnnnを指定し(「nnnnn」はレビューID)、Swarmの外部でそのチェンジリストを追加すると、そのチェンジリストが却下されます。

   次の賛成票をカウント:

   デフォルトでは、レビューに対するすべての賛成票が、そのレビューに関連するプロジェクトまたはブランチで設定されている[最小賛成票]の値としてカウントされます。カウントする賛成票を、レビューが関連付けられているプロジェクトのメンバーだけに制限する場合は、このルールを使用します。

   特定のユーザがレビューに賛成票を入れた場合に、このルールが適用されます。

   以下に示すいずれかのオプションを選択します。

   • すべてのユーザ: レビュー内で設定されているすべてのレビュー担当者による投票がカウントされます。これが、デフォルトの設定です。
   • Members: レビューが関連付けられているプロジェクトのメンバーが投票した賛成票だけが、プロジェクトまたはブランチで設定されている[最小賛成票]の値としてカウントされます。
   ヒント

   プロジェクトやブランチで[最小賛成票]の値を設定する方法については、「プロジェクトの最小賛成票」と「ブランチの最小賛成票」を参照してください。

   自動的にレビューを承認:

   デフォルトでは、手動でレビューを承認する必要があります。レビューを自動的に承認する場合は、このルールを使用します。

   ユーザがレビューに対して投票した場合、必須レビュー担当者がレビューに追加された場合、必須レビュー担当者が任意レビュー担当者になった場合に、このルールが適用されます。

   以下に示すいずれかのオプションを選択します。

   • しない: レビューが自動的に承認されることはありません。これが、デフォルトの設定です。
   • 投票数ベース: 以下の場合に、レビューが自動的に承認されます。
     • レビューに対する反対票がない場合。
     • レビューのモデレータが設定されていない場合。モデレータが設定されているレビューを自動的に承認することはできません。
     • すべての必須レビュー担当者が、レビューに対して賛成票を入れた場合。
     • レビューで設定されている[最小賛成票]の値が、そのレビューに関連するすべてのプロジェクトとブランチの要件を満たしている場合。
     • 承認をブロックするように設定されているすべてのテストがパスした場合。
     重要

     モデレータが設定されているレビューを自動的に承認することはできません。モデレータの詳細については、「モデレータ」を参照してください。

     ヒント

     自動的に承認されたレビューは、手動でコミットする必要があります。

7. [テスト]

任意: ワークフローにテストを追加します。テストは、ワークフローに関連付けられたレビューの作成時、更新時、または送信時に実行されます。テストの[日時]ドロップダウンから選択されます。

ヒント
• テストは、[保存]ボタンをクリックしたときにのみワークフローに保存されます。
• レビューが複数のワークフローに関連付けられている場合、それらすべてのワークフローのすべてのテストがレビュー用に実行されます。同じテストが複数の関連付けられたワークフローで行われる場合、そのテストは1回だけ実行されます。

テストを追加するには: 

1. テスト領域で、をクリックします。
2. [テスト]ドロップダウンリストから実行するテストを選択します。
3. テストを実行する日時を[日時]ドロップダウンリストから選択します。
   ヒント

   • レビューコンテンツの変更とは、レビュー内のファイルまたはファイルのコンテンツが変更されたときを指します。レビューの説明を変更しても、テストはトリガされません。

   • オンデマンドテストは、レビュー内容の変更チェックによる影響を受けることはありません。

   • [更新時]では、テストは次の場合に実行されます。
     • レビューが作成された場合。

     • レビューが送信され、レビューコンテンツが以前のレビューリビジョンと比較して変更された場合。

     • レビューが更新され、以前のレビューリビジョン以降にレビューコンテンツが変更された場合。
   ヒント

   最後にテストにパスしてからレビューの内容が変更されていない場合、レビューのバージョン作成時や送信時にテストが再実行されることはありません。テストがまだ実行中の場合や、Swarmが「パス」状態で更新されていない場合は、送信時にもテストが再実行されます。

   • [送信時]では、プリコミットレビューが送信された場合、またはポストコミットレビューが作成された場合に、テストが実行されます。
   • [オンデマンド]の場合、テストが自動的に実行されることはありませんが、レビューページのテストステータスドロップダウンで手動でテストを実行することができます。
4. テストが失敗した場合にSwarmで承認をブロックするかどうかを、[ブロック]ドロップダウンリストで選択します。
   • [なし]を選択すると、テストが失敗しても承認はブロックされません。
   • [承認]を選択すると、テストが失敗した場合にレビューの承認がブロックされます。
5. [承認] ボタンをクリックして、テストをワークフローに追加します。

ワークフローでテストを編集するには:

1. 編集するテストの横にある[編集] ボタンをクリックします。
2. [テスト]、[日時]、[ブロック]ドロップダウンリストが表示されます。
3. 必要に応じて変更します。
4. [承認] ボタンをクリックして、変更内容を確認します。

ワークフローからテストを削除するには:

ワークフローから削除するテストの横にある[削除] ボタンをクリックします。

テストはすぐに削除されます。確認は要求されません。テストの削除を完了するには、ワークフローを保存する必要があります。

8. [保存]をクリックします。

   注意

   いずれかの必須フィールドに値が入力されていない場合は、[保存]ボタンが無効になります。