カスタムフロー

カスタムフローは、GitLabプロジェクト全体にわたる複雑な複数ステップのタスクを自動化するために作成および設定できる、AIを活用したワークフローです。

フローの表示レベル

カスタムフローを作成する際は、そのフローを管理するプロジェクトを選択し、フローを公開または非公開のどちらにするかを選択します。

公開フロー:

• インスタンス上の誰でも閲覧でき、前提条件を満たすすべてのプロジェクトで有効にできます。

非公開フロー:

• 閲覧できるのは以下のみです:
  • 管理プロジェクトのメンバーで、ゲスト、プランナー、レポーター、デベロッパー、メンテナー、またはオーナーロールを持つユーザー。
  • トップレベルグループのオーナーロールを持つユーザー。
• 管理対象プロジェクト以外のプロジェクトや、トップレベルグループ以外のグループでは有効にできません。

フローが有効な場合、パブリックフローをプライベートに変更することはできません。

プロジェクトのフローを表示する

前提条件:

• プロジェクトのデベロッパー、メンテナー、またはオーナーロールが必要です。

プロジェクトに関連付けられたフローのリストを表示するには:

1. 上部のバーで、検索または移動先を選択して、プロジェクトを見つけます。
2. 自動化 > フローを選択します。
   • プロジェクトで有効になっているフローを表示するには、有効タブを選択します。
   • プロジェクトで管理されているフローを表示するには、管理中タブを選択します。

フローを選択すると、その詳細を確認できます。

フローを作成する

プロジェクトからフローを作成するか、AIカタログを使用して作成できます。

前提条件:

• プロジェクトのメンテナーまたはオーナーロールが必要です。

フローがAIカタログに表示されます。

フローを有効にする

フローを有効にすると、イシュー、マージリクエスト、またはディスカッションからフローをトリガーできます。

プロジェクトでフローを有効にすると、同時にそのプロジェクトのトップレベルグループでも有効になります。

前提条件:

• プロジェクトのメンテナーまたはオーナーロールが必要です。

フローはグループおよびプロジェクトの自動化 > フローページに表示されます。トップレベルグループ内の任意のプロジェクトのメンバーは、そのプロジェクトでフローを有効にできます。

グループ内にサービスアカウントが作成されます。アカウント名は次の命名規則に従います: ai-<flow>-<group>。

プロジェクトで有効にする

フローがトップレベルグループで既に有効になっている場合、そのグループのプロジェクトでフローを有効にできます。

前提条件:

• プロジェクトのメンテナーまたはオーナーロールが必要です。
• プロジェクトのトップレベルグループでフローを有効にする必要があります。

プロジェクトでフローを有効にするには:

1. 上部のバーで、検索または移動先を選択して、プロジェクトを見つけます。
2. 自動化 > フローを選択します。
3. 右上隅で、グループからのフローを有効にするを選択します。
4. ドロップダウンリストから、有効にするフローを選択します。
5. トリガーを追加で、フローをトリガーするイベントを選択します:
   • メンション: イシューまたはマージリクエストのコメントでサービスアカウントユーザーがメンションされたとき。
   • 割り当て: サービスアカウントユーザーがイシューまたはマージリクエストに割り当てられたとき。
   • レビュアーを割り当てる: サービスアカウントユーザーがレビュアーとしてマージリクエストに割り当てられたとき。
6. 有効化を選択します。

プロジェクトの自動化 > フローリストにフローが表示されます。

トップレベルグループのサービスアカウントがプロジェクトに追加されます。このアカウントにはデベロッパーロールが割り当てられます。

フローを無効にする

前提条件:

• グループの場合、メンテナーまたはオーナーのロールが必要です。
• プロジェクトの場合、メンテナーまたはオーナーのロールが必要です。

フローを無効にするには:

1. トップバーで検索または移動先を選択し、グループまたはプロジェクトを見つけます。
2. 自動化 > フローを選択します。
3. 削除するフローを見つけて、アクション（ ）> 無効化を選択します。
4. 確認ダイアログで、無効化を選択します。

フローはプロジェクトまたはグループに表示されなくなり、実行できなくなります。フローに関連付けられていたサービスアカウントまたはトリガーもすべて削除されます。

トリガーを作成する

次に、フローがいつ実行されるかを定義するトリガーを作成する必要があります。

たとえば、ディスカッションでフローサービスアカウントユーザーにメンションしたとき、またはサービスアカウントをレビュアーとして割り当てたときに、フローがトリガーされるよう指定できます。

プロジェクトでフローを有効にすると、トリガーも作成されます。

フローを使用する

前提条件:

• プロジェクトのデベロッパー、メンテナー、またはオーナーロールが必要です。
• プロジェクトでフローを有効にする必要があります。

フローを使用するには:

1. プロジェクトで、イシュー、マージリクエスト、またはエピックを開きます。

2. フローをトリガーするには、フローサービスアカウントユーザーに対して、メンション、割り当て、またはレビューのリクエストを行います。デフォルトでは、ユーザーの名前はai-<flow>-<group>です。

   たとえば、Security scannerという名前のフローをGitLab Duoグループで有効にした場合、サービスアカウントユーザーはai-security-scanner-gitlab-duoです。

3. フローがタスクを完了すると、確認メッセージが表示され、すぐにマージ可能な変更またはインラインコメントが表示されます。

フローを複製する

元のフローを上書きせずに変更を加えるには、既存のフローのコピーを作成します。

前提条件:

• プロジェクトのメンテナーまたはオーナーロールが必要です。

フローを複製するには:

1. 上部のバーで、検索または移動先 > 検索を選択します。
2. AIカタログを選択し、次にフロータブを選択します。
3. 複製するフローを選択します。
4. 右上隅で、アクション（ ）> 重複を選択します。
5. オプション。変更するフィールドを編集します。
6. フローを作成を選択します。

フローを編集する

フローを編集して設定を変更します。

前提条件:

• 管理プロジェクトのメンバーであり、メンテナーまたはオーナーのロールが必要です。

1. トップバーで検索または移動先を選択し、グループまたはプロジェクトを見つけます。
2. 自動化 > フローを選択します。
3. 編集するフローを選択します。
4. 右上隅で、編集を選択します。
5. 変更するフィールドを編集し、変更を保存を選択します。

フローを非表示にする

フローを非表示にして、AIカタログから削除します。

フローを非表示にすると、ユーザーはそれを有効にできません。ただし、既に有効になっているグループやプロジェクトでは、引き続きトリガーすることができます。

前提条件:

• 管理プロジェクトのメンバーであり、メンテナーまたはオーナーのロールが必要です。

フローを非表示にするには:

1. トップバーで検索または移動先を選択し、グループまたはプロジェクトを見つけます。
2. 自動化 > フローを選択します。
3. 非表示にするフローを見つけ、アクション ( ) > 非表示を選択します。
4. 確認ダイアログで、確認を選択します。

フローを削除する

フローを削除して、インスタンスから完全に削除します。

前提条件:

• 管理者である必要があります。

1. トップバーで検索または移動先を選択し、グループまたはプロジェクトを見つけます。
2. 自動化 > フローを選択します。
3. 削除するフローを見つけ、アクション ( ) > 削除を選択します。
4. 確認ダイアログで、削除を選択します。

グループ共有とフロー

グループでフローを有効にすると、関連するサービスアカウントが自動的に作成されます。このサービスアカウントには次の特性があります:

• 複合アイデンティティ認証を使用し、フローを実行するユーザー以上のアクセス権をフローが持たないようにします。
• フローを有効にしたトップレベルグループ配下のすべてのプロジェクトのメンバーとして追加されるため、フローがそのグループ外のリソースにアクセスすることはできません。
• トップレベルグループと共有されている追加のグループへのアクセス権が付与されます。グループ共有においては、このサービスアカウントは他のグループメンバーと同様に扱われます。