最もリクエストの多かったCodeRabbit機能の1つ：マルチリポジトリ分析の紹介

The most requested CodeRabbit feature: Multi-Repo Analysisの意訳です。

すべてのチェックをパスし、レビューでも問題なさそうに見えたプルリクエストをマージしたら、10分後にダウンストリームのサービスが壊れてしまった...という経験があれば、この問題をすでにご存知でしょう。

アーキテクチャが複数のリポジトリにまたがっている場合（マイクロサービス、共有ライブラリ、フロントエンドとバックエンドの分離など）、ある場所での変更が、別の場所で静かに破壊を引き起こすことがあります。APIレスポンススキーマのフィールド名を変更した場合はどうでしょうか？PRでは問題なく見えますが、そのレスポンスをパースしている3つのサービスにおいて何が起こるのか知る由もありません。

これは、マルチリポジトリ構成で運用しているチームから最もよく聞く課題の一つであり、お客様から最もリクエストの多かった機能の一つです。

そこで、私たちはそれを解決できるマルチリポジトリ分析機能を構築しました。

Multi-Repo Analysisのご紹介

Multi-Repo analysis（マルチリポジトリ分析）は、ProおよびEnterpriseティアユーザー向けの新しいCodeRabbitの機能です。この機能により、関連するリポジトリを接続して、コードレビュー中にCodeRabbitがすべてのリポジトリからコンテキストを引き出すことができます。マイクロサービス、共有ライブラリ、APIコントラクトの変更、あるいは1つのリポジトリでの変更が別のリポジトリを静かに壊す可能性があるあらゆる構成を想定しています。

プルリクエストが共有API、型定義、またはデータベーススキーマを変更すると、CodeRabbitは自動的にリンクされたリポジトリを探索して、ダウンストリームへの影響を調査します。

変更を単独でレビューするのではなく、マージする前に全体像を把握できます。

セットアップと設定

使用を開始する前に、CodeRabbitボットがすべてのリンクされたリポジトリへの読み取りアクセス権を持っていることを確認するために、いくつかのプラットフォーム固有の要件を確認する必要があります。

プラットフォーム	要件
GitHub	CodeRabbit GitHub Appがすべてのリンクされたリポジトリにインストールされている必要があります。アクセスできないリポジトリはスキップされ、レビューサマリーに警告が表示されます。
GitLab	ボットトークンが読み取りアクセス権を持っている必要があります。トークンは通常、グループまたはインスタンスにスコープされています。
Bitbucket Cloud	ボットトークンが読み取りアクセス権を持っている必要があります。トークンはワークスペースにスコープされています。
Azure DevOps	PATが読み取りアクセス権を持っている必要があります。トークンは組織にスコープされています。

設定が完了したら、2つの方法でセットアップを完了できます。

• CodeRabbit Webインターフェースから

  • Repositoriesセクションに移動し、リンクされたリポジトリを追加したいリポジトリを選択します

  • Use Organization Settings トグルをオフに切り替えます

  • Knowledge Baseに移動し、Linked Repositoriesセクションを見つけてください

  • レビュー中にCodeRabbitをガイドする指示と共に、新しいリンクされたリポジトリを追加します

• YAML設定ファイルから

  • .coderabbit.yamlファイルのknowledge_baseの下にlinked_repositoriesセクションを追加します

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
knowledge_base:
  linked_repositories:
    - repository: "myorg/backend-api" # リポジトリ名
      instructions: "Contains REST API endpoints and database models" # リポジトリに関する説明

現時点では、各リポジトリの設定は1つのリンクされたリポジトリのみをサポートしていますが、将来的には複数のリンクされたリポジトリがサポートされる予定です。完全なセットアップの詳細については、ドキュメントを確認してください。

実際の動作について

実際に動作するウォークスルーとして、Developer Advocateの一人が、Multi-Repo analysisがレビューで実際のクロスリポジトリの問題を検出する様子を示すチュートリアルを作成しています。

今すぐ試す

Multi-Repo analysis機能は本日より利用可能です。リポジトリを接続し、PRを開いて、CodeRabbitに見逃していた要件を見せてもらいましょう。

今すぐ始める