🌱

Git 特定のコミットを取り込む(cherry-pick) と コミットをまとめてマージ(merge --squash)

2024/11/15に公開

特定のコミットだけを取り込みたい!(cherry-pick)

git cherry-pick は特定のコミットのみを取り込みたいときに使用します。
スクリーンショット 2023-12-18 10.16.52.png
上の図で自分がブランチ2(作業ブランチ)で複数コミットをして、そのうちのコミットA,Bのみを親ブランチであるブランチ1に含ませたいとき、git cherry-pickが有効です。


差分を取り込みたいブランチ(図の場合ブランチ1)に移動し、取り込みたいコミット番号を指定してcherry-pickをします。(オレンジはコミット番号です)


git checkout ブランチ1
git cherry-pick abcd0001 abcd0002

これだけで指定したコミットを取り込むことができます。また、このときログを見ると新たなコミット番号が追加されています。取り込んだ後にコミットまでされるので、一旦差分のみ取り込みたいときは-nオプションをつけることで解決できます。

git cherry-pick -n abcd0001 abcd0002

スクリーンショット 2023-12-18 10.17.04.png

また、連続したコミットを取り込みたいときは...

git checkout ブランチ1
git cherry-pick abcd0001..abcd0004

とすると連続したコミットを取り込むことができます。


コミットをまとめたい!(merge --squash)

普通のマージとスカッシュマージの違いについて

下図のような状態があったとします。
スクリーンショット 2023-12-18 10.23.55.png

ブランチ2で作業をして、ブランチ1にマージするとき

git checkout ブランチ1
git merge ブランチ2

をしたとき、当たり前ですが、ブランチ1にブランチ2の差分がマージされます。このとき、B,C,Dのコミットはそのままマージされるので、ブランチ1でgit log を確認すると3つのコミットのログが確認できると思います。

スクリーンショット 2023-12-18 10.24.02.png



これでも問題ないのですが、例えば、ちょっとした修正がありコミットが多くなると、細かいコミットが何個も生成され、ログも増え、確認したいときに困惑することがあるかもしれません。






そこで、複数コミットを1つにまとめる、squash mergeを使います。使い方は先ほどのmergeコマンドにオプションを指定するだけです。

git checkout ブランチ1
git merge --squash ブランチ2

スクリーンショット 2023-12-18 10.24.07.png





ログはすっきりしますが、変更箇所が分かりにくくなるというデメリットもあるので、故意にコミットを細かく分けているときは気をつけた方がいいかもしれません。

GitHubで編集を提案

Discussion