コードレビューフロー
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed
アドオンによっては、代わりにGitLab Duoコードレビューにアクセスできる場合があります。2つの機能の比較説明をご覧ください。
コードレビューフローは、エージェント型AIを活用してコードレビューを効率化します。
このフローには次の特長があります:
- コードの変更、マージリクエストコメント、リンクされたイシューを分析します。
- リポジトリ構造やファイル間の依存関係を踏まえて、より高度にコンテキストを理解します。
- 実行可能なフィードバックを含む、詳細なレビューコメントを提供します。
- プロジェクトに合わせて調整されたカスタムレビュー指示をサポートします。
このフローはGitLab UIでのみ使用できます。
フローを使用する
前提条件:
- Agent Platformの前提条件を満たしていることを確認してください。
- トップレベルグループで基本フローを許可とコードレビューが有効になっていることを確認してください。
- プロジェクトのデベロッパー、メンテナー、またはオーナーのロールを持っていることを確認してください。
マージリクエストでコードレビューフローを使用するには:
- 左側のサイドバーで、コード > マージリクエストを選択して、マージリクエストを見つけます。
- 次のいずれかの方法でレビューをリクエストします:
@GitLabDuoをレビュアーとして割り当てます。- コメントボックスに、クイックアクション
/assign_reviewer @GitLabDuoを入力します。
レビューをリクエストすると、コードレビューフローがセッションを開始します。レビューが完了するまでその状況を監視できます。
レビューでGitLab Duoとやり取りする
レビュアーとしてGitLab Duoを割り当てるだけでなく、次の方法でGitLab Duoとやり取りできます:
- レビューコメントに返信して、補足説明や代替案を求める。
- ディスカッションスレッドで
@GitLabDuoをメンションし、フォローアップの質問を行う。
GitLab Duoとのやり取りは、マージリクエストの改善に取り組む際に、提案やフィードバックの向上に役立ちます。
GitLab Duoに提供されたフィードバックは、他のマージリクエスト以後のレビューには影響しません。この機能を追加するリクエストがあります。イシュー560116を参照してください。
カスタムコードレビュー指示
リポジトリ固有のレビュー指示で、コードレビューフローの動作をカスタマイズします。次のようにGitLab Duoに指示できます:
- 特定のコード品質の側面(セキュリティ、パフォーマンス、保守性など)に重点を置く。
- プロジェクトに固有のコーディング標準やベストプラクティスを適用する。
- 特定のファイルパターンを対象に、カスタマイズされたレビュー基準を適用する。
- 特定の種類の変更について、より詳細な説明を提供する。
カスタム指示を設定するには、GitLab Duoへの指示をカスタマイズするを参照してください。
プロジェクトのGitLab Duoによる自動レビュー
GitLab Duoの自動レビューにより、プロジェクト内のすべてのマージリクエストが初期レビューを受けるようになります。マージリクエストが作成されると、次の場合を除き、GitLab Duoがレビューします:
- ドラフトとしてマークされている場合。GitLab Duoにマージリクエストをレビューさせるには、準備完了とマークします。
- 変更が含まれていない場合。GitLab Duoにマージリクエストをレビューさせるには、変更を追加します。
前提条件:
- プロジェクトのメンテナーロール以上が必要です。
@GitLabDuoがマージリクエストを自動的にレビューできるようにするには、以下の手順に従います:
- 上部のバーで、検索または移動先を選択して、プロジェクトを見つけます。
- 設定 > マージリクエストを選択します。
- GitLab Duoコードレビューセクションで、GitLab Duoによる自動レビューを有効にするを選択します。
- 変更を保存を選択します。
グループとアプリケーションのGitLab Duoによる自動レビュー
グループまたはアプリケーションの設定を使用して、複数のプロジェクトで自動レビューを有効にします。
前提条件:
- グループの自動レビューをオンにするには、グループのオーナーロールが必要です。
- すべてのプロジェクトで自動レビューをオンにするには、管理者である必要があります。
グループの自動レビューを有効にするには、以下の手順に従います:
- 上部のバーで、検索または移動先を選択して、グループを見つけます。
- 設定 > 一般を選択します。
- マージリクエストセクションを展開します。
- GitLab Duoコードレビューセクションで、GitLab Duoによる自動レビューを有効にするを選択します。
- 変更を保存を選択します。
すべてのプロジェクトで自動レビューを有効にするには、以下の手順に従います:
- 右上隅で、管理者を選択します。
- 設定 > 一般を選択します。
- GitLab Duoコードレビューセクションで、GitLab Duoによる自動レビューを有効にするを選択します。
- 変更を保存を選択します。
設定は、アプリケーションからグループ、プロジェクトへとカスケードします。より具体的な設定は、より広範な設定をオーバーライドします。
トラブルシューティング
Error DCR4000
Code Review Flow is not enabled. Contact your group administrator to enable the foundational flow in the top-level group. Error code: DCR4000というエラーが表示されることがあります。
このエラーは、基本フローまたはコードレビューフローのいずれかが無効になっている場合に発生します。
管理者に連絡し、トップレベルグループのコードレビューフローを有効にするよう依頼してください。
Error DCR4001
Code Review Flow is enabled but the service account needs to be verified. Contact your administrator. Error code: DCR4001というエラーが表示されることがあります。
このエラーは、コードレビューフローは有効になっているものの、トップレベルグループのサービスアカウントが準備できていないか、まだ作成中の場合に発生します。
サービスアカウントがアクティブになるまで数分待ってから、もう一度お試しください。エラーが解決しない場合は、管理者に連絡してください。
Error DCR4002
No GitLab Credits remain for this billing period. To continue using Code Review Flow, contact your administrator. Error code: DCR4002というエラーが表示されることがあります。
このエラーは、現在の請求期間に割り当てられたGitLabクレジットをすべて使い切った場合に発生します。
管理者に追加のクレジットの購入を依頼するか、次の請求期間の開始時にクレジットがリセットされるまで待ってください。
Error DCR4003
<User>, you don't have permission to create a pipeline for Code Review Flow in this project. Contact your administrator to update your permissions. Error code: DCR4003というエラーが表示されることがあります。
このエラーは、コードレビューフローがCI/CDパイプライン上で実行され、このプロジェクトでパイプラインを作成する権限がないために発生します。
管理者に連絡し、必要なパイプラインを実行する権限を付与するよう依頼してください。
Error DCR4004
<User>, you need to set a default GitLab Duo namespace to use Code Review Flow in this project. Please set a default GitLab Duo namespace in your preferences. Error code: DCR4004というエラーが表示されることがあります。
このエラーは、GitLab Duoがレビューを開始したユーザーのデフォルトGitLab Duoネームスペースを識別できない場合に発生します。
設定でデフォルトGitLab Duoネームスペースを設定し、もう一度レビューをリクエストしてください。
Error DCR4005
Code Review Flow could not obtain the required authentication tokens to connect to the GitLab AI Gateway and the GitLab API. Please request a new review. If the issue persists, contact your administrator. Error code: DCR4005というエラーが表示されることがあります。
コードレビューフローがGitLab AIゲートウェイおよびGitLab APIに接続するには、認証トークンが必要です。このエラーは、トークンを生成できない場合に発生します。これは通常、GitLab Duoの設定が正しくないか、一時的なインフラストラクチャの問題が原因です。
Self-Managedインスタンスの場合、管理者にGitLab Duoの設定を確認するよう依頼してください。
Error DCR4006
Code Review Flow could not add the service account to this project. Contact your administrator to verify that the service account has the required project access. Error code: DCR4006というエラーが表示されることがあります。
このエラーは、サービスアカウントをプロジェクトのメンバーとして追加できない場合に発生します。これは、グループメンバーシップロックが有効になっている場合や、サービスアカウントに必要なアクセス権がない場合に発生する可能性があります。
管理者に連絡し、サービスアカウントがデベロッパーとしてプロジェクトに追加できることを確認するよう依頼してください。
Error DCR4007
Code Review Flow is not available for this project. Contact your administrator to verify that the flow is enabled and the required configuration is in place. Error code: DCR4007というエラーが表示されることがあります。
このエラーは、フローが無効になっているか、プロジェクトに必要な設定がない場合に発生します。
管理者に連絡し、プロジェクトでフローが有効になっていることを確認するよう依頼してください。
Error DCR4008
Code Review Flow could not create the required CI/CD pipeline. Please request a new review. If the problem persists, contact your administrator. Error code: DCR4008というエラーが表示されることがあります。
このエラーは、コードレビューフローがRunnerの可用性の問題や内部の設定の問題により、レビューを実行するためのCI/CDパイプラインを作成または設定できない場合に発生します。
レビューを再試行してください。エラーが解決しない場合は、管理者に連絡してください。
Error DCR5000
Something went wrong while starting Code Review Flow. Please try again later. Error code: DCR5000というエラーが表示されることがあります。
このエラーは、GitLab Duo Agent Platformが内部エラーによりコードレビューフローを開始できない場合に発生します。
レビューを再試行してください。エラーが解決しない場合は、管理者に連絡してください。