Gitのcommit –fixupで、前のコミットをあとから直す方法

​​Git​コマンドライン

2つ以上前のコミットに書き間違いを見つけたときは、git commit --fixup で直す変更をコミットしておき、git rebase -i --autosquash で元のコミットに入れられます。git commit --amend で直せるのは直前のコミット(ブランチの先頭)だけですが、この方法なら、もっと前のコミットも、修正のためだけのコミットを履歴に残さずに直せます。プルリクエストを出す前に、過去のコミットを修正して履歴を整えたいときに使う操作です。

補足

検証環境は Ubuntu 24.04、Git 2.43.0 です。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定し、コミットの日時は環境変数で決めました。エディターを手で操作する代わりに、渡された内容を表示する小さなシェルスクリプトを、環境変数 GIT_SEQUENCE_EDITOR(todo リスト用)と GIT_EDITOR(メッセージ用)に指定しています。メッセージの書き換えも、エディターの代わりにスクリプトでしています。本文のコマンドでは、こうした環境変数の指定を省いています。コマンドのすぐ下に並ぶ pick や fixup の行は、エディターに渡された todo リストで、# で始まる説明の行を除いて載せています。Windows・macOS、Git 2.44 以降、rebase の途中で変更がぶつかる場合、プッシュしたあとのコミットを直す操作は試していません。

直す前の履歴

例として、猫カフェのメモを置いたリポジトリを使います。コミットは4つです。

console
$ git log --oneline
f0a2033 READMEに使い方を書く
735f94a ごはんの時間を追加
499c4be 猫の一覧を追加
dd2d374 READMEを追加

2つ前の「猫の一覧を追加」で作った cats.txt は、「3歳」「5歳」と書いた中で、1か所だけ「2才」になっています。これを「2歳」にそろえます。そのあとに2つのコミットがあるので、--amend では直せません。

直す変更を git commit –fixup でコミットする

まず、ファイルを直して git add します。

console
$ sed -i "s/2才/2歳/" cats.txt

$ git diff
diff --git a/cats.txt b/cats.txt
index e4e2a52..ee6afa9 100644
--- a/cats.txt
+++ b/cats.txt
@@ -1,3 +1,3 @@
 タマ 3歳
 ミケ 5歳
-クロ 2才
+クロ 2歳

$ git add cats.txt

次に、直したいコミットを --fixup= に指定してコミットします。ここではハッシュ 499c4be を git log から取り出して渡しました。メッセージは自動で付き、fixup! 猫の一覧を追加 になります。

console
$ git commit --fixup=$(git log --format=%h -1 --grep="猫の一覧")
[main bf03964] fixup! 猫の一覧を追加
 1 file changed, 1 insertion(+), 1 deletion(-)

$ git log --oneline
bf03964 fixup! 猫の一覧を追加
f0a2033 READMEに使い方を書く
735f94a ごはんの時間を追加
499c4be 猫の一覧を追加
dd2d374 READMEを追加

この時点では、fixup! のコミットは、いちばん上に普通のコミットとして積まれただけです。git commit の公式リファレンスによると、--fixup は件名を「fixup! +直したいコミットの件名」にしたコミットを作ります。git rebase --autosquash は、この件名で直す先を見分けます。

git rebase -i –autosquash で元のコミットに入れる

git rebase -i --autosquash に、直したいコミットまでさかのぼれる範囲を指定します。fixup! のコミットを含めて上から4つなので、HEAD~4 にしました。エディターには次の todo リストが渡されました。

console
$ git rebase -i --autosquash HEAD~4
pick 499c4be 猫の一覧を追加
fixup bf03964 fixup! 猫の一覧を追加
pick 735f94a ごはんの時間を追加
pick f0a2033 READMEに使い方を書く

todo リストは上が古いコミットです。いちばん新しい bf03964 が「猫の一覧を追加」のすぐ下に移り、pick が fixup に書き換わっています。この並べ替えと書き換えを --autosquash がしてくれるので、自分で行を動かす必要はありません(git rebase の –autosquash の説明)。

このまま保存して閉じると、rebase が最後まで進みました。

console
Successfully rebased and updated refs/heads/main.

$ git log --oneline
6d077a3 READMEに使い方を書く
754ef95 ごはんの時間を追加
5c99fde 猫の一覧を追加
dd2d374 READMEを追加
fixup! のコミットは、コミットした順ではいちばん下にあるが、--autosquash で「猫の一覧を追加」のすぐ下に移って fixup になり、rebase のあとは 5c99fde の「猫の一覧を追加」に直した変更が入っている
fixup! のコミットが、直したいコミットに入るまでの流れ

fixup! のコミットはなくなり、コミットは元の4つに戻りました。「猫の一覧を追加」の中身を見ると、最初から「2歳」で作ったことになっています。メッセージは元のままです。

console
$ git show --format="%h %s" HEAD~2
5c99fde 猫の一覧を追加

diff --git a/cats.txt b/cats.txt
new file mode 100644
index 0000000..ee6afa9
--- /dev/null
+++ b/cats.txt
@@ -0,0 +1,3 @@
+タマ 3歳
+ミケ 5歳
+クロ 2歳

直したコミットより後のコミットも作り直されるので、754ef95 と 6d077a3 もハッシュが変わっています。検証では、直す前の f0a2033 に start というタグを付けておきました。直す前と後を比べると、違いは直した1行だけです。

console
$ git diff start HEAD --stat
 cats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

直したいコミットを :/ とメッセージで指定する

ハッシュを調べる代わりに、:/ に続けてメッセージの文字列を書いても指定できます。直す前の状態に戻してから、--fixup=":/猫の一覧" でコミットしたところ、同じ fixup! 猫の一覧を追加 ができました。

console
$ git commit --fixup=":/猫の一覧"
[main bf03964] fixup! 猫の一覧を追加
 1 file changed, 1 insertion(+), 1 deletion(-)

ただし、:/ は、メッセージのどこかが一致するコミットのうち、いちばん新しいものを選びます(コミットの指定方法の公式リファレンス)。いま作った fixup! 猫の一覧を追加 も「猫の一覧」を含むので、続けて :/猫の一覧 を使うと、元のコミットではなく fixup! のコミットが選ばれました。メッセージの先頭が一致するものだけにしたいときは、:/^猫の一覧 のように ^ を付けます。

console
$ git rev-parse --short ":/猫の一覧"
bf03964

$ git rev-parse --short ":/^猫の一覧"
499c4be

うまくまとまらないとき

fixup! のコミットがそのまま残るときは、次の2つを確かめてください。

1つ目は、-i を付けたかどうかです。Git 2.43 で -i を付けずに git rebase --autosquash HEAD~4 を実行すると、「成功した」と表示されますが、履歴は何も変わりませんでした。

console
$ git rebase --autosquash HEAD~4
Successfully rebased and updated refs/heads/main.

$ git log --oneline
bf03964 fixup! 猫の一覧を追加
f0a2033 READMEに使い方を書く
735f94a ごはんの時間を追加
499c4be 猫の一覧を追加
dd2d374 READMEを追加

Git 2.43 の公式リファレンスでは、--autosquash は rebase -i の todo リストを書き換えるもの、と説明されています。Git 2.44 のリリースノートには、-i を付けない rebase でも --autosquash が効くようになった、とあります。

2つ目は、範囲に直したいコミットが入っているかどうかです。HEAD~2 にすると、todo リストに「猫の一覧を追加」が入りません。まとめ先が見つからないので、fixup! のコミットは pick のまま残りました。

console
$ git rebase -i --autosquash HEAD~2
pick f0a2033 READMEに使い方を書く
pick bf03964 fixup! 猫の一覧を追加
Successfully rebased and updated refs/heads/main.

1行目と2行目が todo リスト、3行目は閉じたあとの出力です。範囲は、直したいコミットまで届くように数えます。

rebase.autoSquash で –autosquash を省く

毎回 --autosquash を付けるのが手間なら、設定 rebase.autoSquash を true にします(git config の rebase.autoSquash の説明)。設定したあと、git rebase -i HEAD~4 だけで、--autosquash を付けたときと同じ todo リストになりました。

console
$ git config rebase.autoSquash true

$ git rebase -i HEAD~4
pick 499c4be 猫の一覧を追加
fixup bf03964 fixup! 猫の一覧を追加
pick 735f94a ごはんの時間を追加
pick f0a2033 READMEに使い方を書く
Successfully rebased and updated refs/heads/main.

git config に --global を付けなかったので、この設定はいまのリポジトリだけに効きます。検証では、このあと git config --unset rebase.autoSquash で設定を外しました。

直したいコミットが2つあるとき

fixup! のコミットは、いくつあっても1回の rebase でまとめられます。「ごはんの時間を追加」の「夜 19時」も「夜 18時」に直すことにして、fixup! のコミットを2つ作りました。

console
$ git log --oneline
292b4dd fixup! ごはんの時間を追加
bf03964 fixup! 猫の一覧を追加
f0a2033 READMEに使い方を書く
735f94a ごはんの時間を追加
499c4be 猫の一覧を追加
dd2d374 READMEを追加

5つさかのぼって rebase すると、それぞれの fixup! が、まとめ先のすぐ下に並びました。

console
$ git rebase -i --autosquash HEAD~5
pick 499c4be 猫の一覧を追加
fixup bf03964 fixup! 猫の一覧を追加
pick 735f94a ごはんの時間を追加
fixup 292b4dd fixup! ごはんの時間を追加
pick f0a2033 READMEに使い方を書く
Successfully rebased and updated refs/heads/main.

$ git log --oneline
5f42e5e READMEに使い方を書く
053ee76 ごはんの時間を追加
5c99fde 猫の一覧を追加
dd2d374 READMEを追加

メッセージも直す –fixup=amend: と、メッセージだけ直す –fixup=reword:

--fixup= のあとに amend: を付けると、中身といっしょにメッセージも直せます。reword: を付けると、中身は変えずにメッセージだけを直せます(git commit の公式リファレンス)。どちらも Git 2.32 で追加されました(Git 2.32 のリリースノート)。

直す前の状態に戻し、cats.txt を直して git add してから、--fixup=amend: でコミットしました。エディターには、次のメッセージが渡されました。

console
$ git commit --fixup=amend:":/猫の一覧"
amend! 猫の一覧を追加

猫の一覧を追加

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
(後略)

1行目の amend! 猫の一覧を追加 は、--autosquash がまとめ先を見つけるための件名なので、そのまま残します。3行目から下が、まとめたあとのメッセージになります。ここを「猫の一覧を追加する(年齢つき)」に書き換えて保存しました。

console
[main 5d2bf36] amend! 猫の一覧を追加
 1 file changed, 1 insertion(+), 1 deletion(-)

$ git log -1 --format=%B
amend! 猫の一覧を追加

猫の一覧を追加する(年齢つき)

--autosquash で rebase すると、amend! のコミットは fixup -C として並びます。まとめたあと、「猫の一覧を追加」のメッセージは書き換えたものになりました。

console
$ git rebase -i --autosquash HEAD~4
pick 499c4be 猫の一覧を追加
fixup -C 5d2bf36 amend! 猫の一覧を追加
pick 735f94a ごはんの時間を追加
pick f0a2033 READMEに使い方を書く
Successfully rebased and updated refs/heads/main.

$ git log --oneline
029bc0b READMEに使い方を書く
ba2e49b ごはんの時間を追加
a361f99 猫の一覧を追加する(年齢つき)
dd2d374 READMEを追加

試しに、1行目の amend! 猫の一覧を追加 も消して、メッセージを「猫の一覧を追加する(年齢つき)」の1行だけにすると、amend! で始まらない普通のコミットになりました。--autosquash で rebase しても、todo リストでは pick のままいちばん下に残り、元のコミットにはまとまりませんでした。

console
$ git log --oneline
0d2c441 猫の一覧を追加する(年齢つき)
f0a2033 READMEに使い方を書く
735f94a ごはんの時間を追加
499c4be 猫の一覧を追加
dd2d374 READMEを追加

$ git rebase -i --autosquash HEAD~4
pick 499c4be 猫の一覧を追加
pick 735f94a ごはんの時間を追加
pick f0a2033 READMEに使い方を書く
pick 0d2c441 猫の一覧を追加する(年齢つき)
Successfully rebased and updated refs/heads/main.

メッセージだけを直す --fixup=reword: は、中身を変えない amend! のコミットを作ります。公式リファレンスでは、git add した変更があっても入れない、と説明されています。検証では、何も git add していない状態で「ごはんの時間を追加」を指定し、メッセージの3行目を「ごはんの時間を書く」に書き換えました。

console
$ git commit --fixup=reword:":/ごはんの時間"
(エディターの内容は省略)
[main 6f53680] amend! ごはんの時間を追加

todo リストでは、中身がないことを示す # empty が付いて並びました。まとめたあと、「ごはんの時間を追加」のメッセージだけが変わっています。

console
$ git rebase -i --autosquash HEAD~3
pick ba2e49b ごはんの時間を追加
fixup -C 6f53680 amend! ごはんの時間を追加 # empty
pick 029bc0b READMEに使い方を書く
Successfully rebased and updated refs/heads/main.

$ git log --oneline
71a49ea READMEに使い方を書く
bbdc1ad ごはんの時間を書く
a361f99 猫の一覧を追加する(年齢つき)
dd2d374 READMEを追加
注意

ハッシュが変わるので、プッシュしたあとのコミットは扱いに注意が必要です。Pro Git 日本語版の「歴史の書き換え」では、中央サーバーにプッシュしたコミットを rebase の対象に含めないように、と注意しています。

​Posted by 86