HOWTO · Git

`git reset --soft` の使い方

`git reset --soft` でブランチを過去のコミットへ移動し、変更をステージ済みのまま保つ方法を解説します。ステージ済みの変更を確認し、安全に作業を続ける手順も紹介します。

このページの内容

git reset --soft <target> を使うと、インデックスと作業ツリーを変更せずに、現在のブランチの先端を過去のコミットへ移動できます。移動したコミットによる変更はステージ済みのまま残るため、内容を確認して再度コミットできます。最近のコミットをまとめたり、内容を失わずにコミットメッセージを修正したりするときに便利です。

git reset --soft で変更されるもの

soft reset は、現在のブランチの HEAD とブランチの先端を、指定したコミットへ移動します。ステージング用のインデックスや作業ツリー内のファイルは更新しません。そのため、以前の先端から対象までの変更は、新しい先端を基準にステージ済みとして残ります。このコマンドが影響するのは現在チェックアウトしているブランチだけです。以前のコミットを指している他のブランチは移動しません。

履歴を移動する場合は、対象を必ず指定してください。省略すると Git は HEAD を使うため、ブランチは移動しません。すでにあるステージ済みまたは未ステージの作業もそのまま残ります。後でコミットする内容を正確に把握できるよう、実行後にステージ済みの差分を確認してください。

リセット先のコミットを選ぶ

git log --oneline で最近の履歴を確認します。現在のブランチの先端にしたいコミットを選び、リセットを実行する前にコミットメッセージまたはハッシュを確認してください。たとえば、HEAD~1 は現在のコミットの第1親を意味し、現在の履歴上で1つ前のコミットを指定します。HEAD~2 は第1親を2つたどった位置を指定します。ブランチ名、タグ、コミットハッシュでも対象を指定できます。

対象とは、削除するコミットではなく、ブランチの先端として残すコミットです。HEAD~1 にリセットするとブランチは1コミット分戻り、以前の先端による変更はステージ済みで残ります。履歴が直線的でない場合は、番号付きの親指定が意図したコミットを指すと思い込まず、ログで対象を確認してください。

変更をステージ済みのままコミットをリセットする

1つのコミットをリセットする場合は、まずログを確認してから git reset --soft HEAD~1 を実行します。最近の複数のコミットをまとめるには、たとえば git reset --soft HEAD~3 のように、適切な過去の対象を指定します。インデックスと作業ツリーは保たれるため、それらのコミットによる変更をまとめて新しいコミットにできます。

次の例を実行します。

このセクションのコードと表示されるラベルや出力は英語のままです。

work_dir="$(mktemp -d)"
trap 'rm -rf "$work_dir"' EXIT
cd "$work_dir"
git init -q
git config user.name "Example User"
git config user.email "example@example.com"
printf 'first version\n' > note.txt
git add note.txt
git commit -qm "Add note"
printf 'second version\n' > note.txt
git commit -qam "Update note"
git reset --soft HEAD~1
git status --short

この例は正常に終了し、M note.txt と表示されます。これは、soft reset 後も変更がステージ済みであることを示しています。

ステージ済みの変更を確認する

リセット後、git status で意図したファイルがステージ済みか確認します。次のコミットを作成する前に、git diff --cached でステージ済みの差分を詳しく確認してください。--cached オプションは、インデックスと、現在選択されている対象である HEAD を比較します。表示された変更が意図したものと異なる場合は、コミットする前に手を止め、対象と差分を確認してください。

ステージ済みの差分に問題がなければ、git commit -m "Describe the combined change" で置き換え用のコミットを作成します。直近のコミットを更新するには、git commit --amend で置き換えます。その場合は、確定する前にステージ済みの内容とコミットメッセージをよく確認してください。soft reset 自体が新しいコミットを作成したり、コミットメッセージを変更したりすることはありません。

--soft、--mixed、--hard の違い

3つのリセットモードはいずれも現在のブランチの先端を対象へ移動しますが、インデックスと作業ツリーの扱いが異なります。

  • git reset --soft <target> はブランチの先端を移動し、インデックスと作業ツリーの両方を変更しません。対象となるコミット済みの変更はステージ済みで残ります。
  • git reset --mixed <target> はブランチの先端を移動し、作業ツリー内のファイルはそのままにして、インデックスを対象に合わせます。移動したコミットによる変更は未ステージになります。モードを指定しない場合の既定値は --mixed です。
  • git reset --hard <target> はブランチの先端を移動し、インデックスと追跡対象の作業ツリー内ファイルを対象に合わせます。対象に含まれない追跡対象ファイルの編集内容は破棄される場合があるため、その結果を意図している場合に限り使用してください。

リセットモードは通常、関係のない未追跡ファイルをそのまま残します。ただし、対象の追跡対象パスを書き込む妨げになる場合、git reset --hard は未追跡のファイルやディレクトリを削除することがあります。置き換え用のコミットに向けて変更をステージ済みにしておきたい場合は --soft を、未ステージの状態で確認したい場合は --mixed を選んでください。soft reset の代わりに --hard を使わないでください。

git reset --soft を安全に使う場面

soft reset は、複数のコミットを1つにまとめたり、その変更を別のコミットにまとめる準備をしたりするなど、最近のローカル履歴を編集するときに適しています。実行前に git status と git log --oneline で現在のブランチと対象を確認してください。実行後は、関係のないステージ済みの作業を誤って含めないよう、コミットする前に git status と git diff --cached を確認します。

コミットをすでに共有している場合、ブランチを移動すると、他の人が作業の基準にしている可能性のある履歴を書き換えます。共有済みの履歴を変更する前に調整してください。履歴を保ったまま公開済みの変更を取り消したい場合は、通常 git revert のほうが適しています。soft reset は後で push するまではローカルリポジトリだけを変更しますが、書き換えた履歴を push すると共同作業者に支障が出ることがあります。対象とステージ済みの差分を明確に把握し、通常の後続手順として安易に強制 push しないでください。