Resolve Merge Conflictsの紹介

Introducing Resolve Merge Conflictsの意訳です。

マージしようとしたとき、すべてがグリーンなのに、GitHubからこう言われたことはないでしょうか。「This branch has conflicts that must be resolved.」。そのとき、あなたがやることは以下の手順です。

mainをプルする
ブランチを切り替える
コンフリクトしているファイルを開く
もう一人の開発者がこのコードで何をしようとしていたのか思い出そうとする
行をなんとかつなぎ合わせて、壊れないことを祈る
プッシュしてCIの結果を待つ

コンフリクトマーカーは、実際には衝突していないコードの周りにあるノイズにすぎません。

それなのに、なぜこんな細かい作業に時間を取られなければならないのでしょうか。

Resolve Merge Conflictsとは

CodeRabbitがPRのコンフリクトを検出すると、Resolve Merge Conflictsが自動で解消します。両方の変更の意図を読み取り、統合すべき正しい結果を判断し、適切なマージコミットとしてブランチにコミットします。CodeRabbit Pro Plusプランにて、GitHubとGitLabの両方で利用可能です。具体的な流れは以下のとおりです。

従来の手動での方法

これまでは、作業を中断してブランチを切り替え、他の開発者の変更と自分の変更を手動で照合していたはずです。その後CIを再実行し、何か見落としがないことを祈る、という流れでした。

コメント1つで完了する新しい方法

コメントを書くだけで、CodeRabbitがコンフリクトを解消し、両方の親を持つマージコミットがブランチに作成されます。

仕組み

この機能を使う方法は2つあります。

PRにコメントする

PRのスレッドで以下のようにコメントするだけです。

ダークテーマのターミナルウィンドウに表示された「@coderabbitai resolve merge conflict」コマンド。

PRウォークスルーのチェックボックス

GitHubでは、CodeRabbitがレビュー中にコンフリクトを検出すると、ウォークスルーコメント内に「Resolve merge conflicts」チェックボックスが表示されます。チェックを入れるだけで実行できます。

どちらの方法でも、解消された変更がブランチに直接コミットされます。

実行時に何が起きるか

コンフリクト解消が実行されると、内部では以下の処理が行われます：

検出： PRレビュー中に、CodeRabbitがサンドボックス内でマージをシミュレーションし、サマリーコメントにコンフリクトを一覧表示します。作業ツリーには一切影響しません。
意図の分析： コンフリクトしている各ファイルについて、エージェントが両方のブランチを読み、単に何が変更されたかだけでなく、それぞれの変更がなぜ行われたかを把握します。
解消： AIエージェントが各コンフリクトを根本から推論します。リポジトリ内で直接作業し、gitの状態を調べ、ファイルを読み、gitコマンドを実行し、コードを編集します。正しい結果のために必要であれば、コンフリクト箇所以外の変更も行えます。
検証： コンフリクトマーカーが残っていないこと、マージインデックスがクリーンであることを確認し、リポジトリのビルドとlintを実行して、解消によって導入されたエラーがないかを検出します。
コミット： 結果は2つの親（自分のブランチとベースブランチ）を持つ適切なマージコミットとして記録されるため、git履歴に実際の経緯が正しく反映されます。

特に役立つ場面

GitHub上でプルリクエストのコンフリクトがWebエディタでは解消できないほど複雑だった経験はないでしょうか。Resolve Merge Conflicts機能があれば、「use the command line to resolve conflicts before continuing」というエラーメッセージに作業を止められることはもうありません。