カスタムフロー

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

Flowの表示レベル

カスタムフローを作成する際に、それを管理するGitLabプロジェクトを選択し、flowを公開にするかプライベートにするかを選択します。

公開フロー:

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

プライベートフロー:

• 管理GitLabプロジェクトのメンバーで、少なくともデベロッパーロールを持つユーザー、およびトップレベルグループのオーナーロールを持つユーザーのみが表示できます。
• 管理GitLabプロジェクト以外のGitLabプロジェクト、またはトップレベルグループ以外のグループでは、有効にできません。

flowが現在有効になっている場合、プライベートflowを公開に変更することはできません。

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

前提要件:

• プロジェクトのデベロッパーロール以上を持っている必要があります。

GitLabプロジェクトで有効になっているフローのリストを表示するには、次のようにします:

1. 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。新しいナビゲーションをオンにしている場合、このフィールドは上部のバーにあります。
2. 自動化 > フローを選択します。

Flowを選択して詳細を表示します。

Flowを作成

前提要件:

• プロジェクトのメンテナーロール以上が必要です。

Flowを作成するには、次のようにします:

1. 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。新しいナビゲーションをオンにしている場合、このフィールドは上部のバーにあります。
2. 自動化 > フローを選択します。
3. 新しいフローを選択します。
4. 基本情報の下:
   1. 表示名に名前を入力します。
   2. 説明に説明を入力します。
5. 表示レベルとアクセスの表示レベルで、プライベートまたは公開を選択します。
6. 設定の下:
   1. flowを選択します。
   2. エディタで、flowの設定を入力します。カスタムフローYAMLの記述方法については、flow registry framework documentationを参照してください。
7. フローを作成を選択します。

FlowはAIカタログに表示されます。

Flowを有効にする

Flowを有効にすると、イシュー、マージリクエスト、またはディスカッションからトリガーできます。Flowを有効にするには、以下を実行する必要があります:

1. トップレベルグループで有効にします。
2. 使用するGitLabプロジェクトで有効にします。

トップレベルグループで有効にする

前提要件:

• グループのオーナーロールを持っている必要があります。

トップレベルグループでflowを有効にするには、次のようにします:

1. 左側のサイドバーで、検索または移動先 > 検索を選択します。新しいナビゲーションをオンにしている場合、このフィールドは上部のバーにあります。
2. AIカタログを選択し、次にフロータブを選択します。
3. 有効にするflowを選択します。
4. 右上隅で、グループで有効にするを選択します。
5. ドロップダウンリストから、flowを有効にするグループを選択します。
6. 有効を選択します。

Flowは、グループの自動化 > フローページに表示されます。

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

前提要件:

• プロジェクトのメンテナーロール以上が必要です。
• Flowは、GitLabプロジェクトのトップレベルグループで有効にする必要があります。

GitLabプロジェクトでflowを有効にするには、次のようにします:

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

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

Flowを無効にする

前提要件:

• グループの場合、オーナーロールが必要です。
• プロジェクトでは、少なくともメンテナーロールが必要です。

Flowを無効にするには、次のようにします:

1. 左側のサイドバーで、検索または移動先を選択して、グループまたはプロジェクトを見つけます。新しいナビゲーションをオンにしている場合、このフィールドは上部のバーにあります。
2. 自動化 > フローを選択します。
3. 削除するflowを見つけて、アクション ( ) > 無効を選択します。
4. 確認ダイアログで、無効化を選択します。

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

トリガーを作成する

次に、トリガーを作成する必要があります。これにより、flowがいつ実行されるかが決定されます。

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

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

Flowを使用する

前提要件:

• プロジェクトのデベロッパーロール以上を持っている必要があります。
• Flowは、GitLabプロジェクトで有効にする必要があります。

Flowを使用するには、次のようにします:

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

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

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

3. Flowがタスクを完了すると、確認が表示され、すぐにマージできる変更またはインラインコメントが表示されます。

Flowを複製する

元のエージェントを上書きせずにflowを変更するには、既存のエージェントのコピーを作成します。

前提要件:

• プロジェクトのメンテナーロール以上が必要です。

Flowを複製するには、次のようにします:

1. 左側のサイドバーで、検索または移動先 > 検索を選択します。新しいナビゲーションをオンにしている場合、このフィールドは上部のバーにあります。
2. AIカタログを選択し、次にフロータブを選択します。
3. 複製するflowを選択します。
4. 右上隅で、アクション ( ) > 複製を選択します。
5. オプション。変更するフィールドを編集します。
6. フローを作成を選択します。

フローを管理

Flowを編集して設定を変更するか、削除してAIカタログから削除します。

前提要件:

• 管理対象のGitLabプロジェクトのメンバーであり、メンテナーロール以上を持っている必要があります。

1. 左側のサイドバーで、検索または移動先 > 検索を選択します。新しいナビゲーションをオンにしている場合、このフィールドは上部のバーにあります。
2. AIカタログを選択し、次にフロータブを選択します。
3. 管理するflowを選択します。
   • Flowを編集するには、次のようにします:
     1. 右上隅で、編集を選択します。
     2. 変更するフィールドを編集し、変更を保存を選択します。
   • Flowを削除するには、次のようにします:
     1. 右上隅にあるアクション（ ）> 削除を選択します。
     2. 確認ダイアログで、削除を選択します。

Flowをレポート

潜在的に不快な内容が含まれている場合、または組織にリスクをもたらす可能性があるflowをレポートできます。

Flowをレポートするには、次のようにします:

1. 左側のサイドバーで、検索または移動先 > 検索を選択します。新しいナビゲーションをオンにしている場合、このフィールドは上部のバーにあります。
2. AIカタログを選択し、次にフロータブを選択します。
3. レポートするflowを選択します。
4. 右上隅で、アクション ( ) > Report to admin（管理者に報告）を選択します。
5. 不正行為のレポートに入力し、送信を選択します。

管理者に通知が送信され、flowを非表示または削除できます。