[Git]コンフリクトをよりスマートに解消したい！

ディップ Advent Calendarの21日目です。

はじめに

現在、うちのチームではRuby on Railsで開発を進めており、
ソースコード管理にはGitHub Enterpriseを使っています。

精鋭たちが「えいやーっ！」と並行開発している状況なので、
気を付けないと意図せず開催されてしまうんです...コンフリクト祭りが。

そんなとき、普通はローカルで修正→PUSHで解決すると思います。こんな感じで。

ですが、人の手でやることなので、量が多いと面倒だし、ツラいし、ミスも発生しやすくなります。
うちのチームでも、プルリクエスト内で時折こんなコメントを見かけたりします。

コンフリクトマーカーが残ったままです！修正をお願いします！

...これは、レビューする人も直す人もツラい。
なので、よりスマートにコンフリクトを解消する術を改めてまとめてみました。

片方のブランチの変更内容を採用する

チェックアウトしている側のブランチの変更を採用したい場合

$ git checkout --ours {ファイル名}

相手側のブランチの変更を採用したい場合

$ git checkout --theirs {ファイル名}

いちいちファイルを開いて修正して...ということをしなくてよいのでラクちんです。
でも、両方のブランチの変更内容を採用したいことの方が多いので、なかなか活用の機会がありません...

そこで考えたもう一つの策がこちら↓

Gitフックを活用し、人的ミスをコミット前に防ぐ

完全に人の手でやろうとするからツラいのです。
ならば、可能な限り機械に任せてしまいたい！

コンフリクトマーカーが残っていないか確認する方法

みなさん同じ悩みを抱えているようで、既に素敵な方法が世の中には存在しました！
なので、ありがたく活用させていただくことにしました。

• Blocking merge conflicts in commits with Git

上記のサイトを参考に、私は少しカスタマイズして使っています。

• ======= のチェックも追加したかったので、17行目を修正

pre-commit

#!/bin/sh

## pre-commit script to prevent merge markers from being committed. 
## Author: Jon Dowdle <[e-mail]>

##
## This simply searches the files that you are about to commit.
##

changed=$(git diff --cached --name-only)

if [[ -z "$changed" ]]
then
    exit 0
fi

echo $changed | xargs egrep '[><=]{7}' -H -I --line-number

## If the egrep command has any hits - echo a warning and exit with non-zero status.
if [ $? == 0 ]
then
    echo "WARNING: You have merge markers in the above files, lines. Fix them before committing."
    exit 1    
fi

使い方

• .git/hooks/pre-commitに上記の処理を書く
• 実行権限を付与する

これだけ！

すると、git commitの処理前に上記の処理が走り、
もしコンフリクトマーカー（>>>>>>>,<<<<<<<,=======）が存在したらコミットを中止します。

これでもう、

コンフリクトマーカーが残ったままです！修正をお願いします！

なんていうコメントは撲滅できそうです。スバラシイ！

もしGitフックを無効にしてコミットしたい場合は、git commit --no-verifyとすればよい。

おわりに

もっと賢くコンフリクト対応できる術はないかな...引き続きいろいろ試してみようと思います。

それから、Gitフック！これまであまり活用できていなかったのですが可能性が広がりました。
デフォルトでもいろいろ用意されているので、うまくカスタマイズしたいなー。
それに、世の中には活用されてる事例が既にたくさんあるので、今後もっと勉強して活用したいと思います！

Appendix

参考にしたサイト

• Blocking merge conflicts in commits with Git
• Git - Git フック

参考：いつもやっているコンフリクト解決方法

1. ローカルリポジトリでブランチの最新化

ローカルにブランチを作成するところから始めると以下のような感じから。

$ git fetch origin
$ git checkout -b feature/branch-name origin/feature/branch-name

既にfeature/branch-name がローカルに存在する場合は、以下の対応をすると良い。

$ git fetch origin

# developブランチの最新化
$ git checkout develop
$ git merge origin/develop

# featureブランチの最新化
$ git checkout feature/branch-name
$ git merge origin/feature/branch-name

2. featureブランチにdevelopブランチの変更をマージする

$ git checkout feature/branch-name

$ git merge develop

ここでコンフリクトが起きるはずなので、
CONFLICT (content): Merge conflict in {ファイル名}
と表示されたファイルを1つずつ修正する。

ファイルを開いて直接変更。

<<<<<<< HEAD

{featureブランチで変更した内容}

=======

{developブランチで変更した内容}

>>>>>>> develop

3. すべて解決できたらコミットを続ける

$ git add .
$ git commit

4. リモートヘPUSH

$ git push origin feature/branch-name