git stashで作業中の変更を一時的によける方法

​​Git​コマンドライン

作業の途中で別のブランチに切り替えたいのに、コミットしていない変更が切り替え先の内容とぶつかって、git switch が止まることがあります。git stash を使うと、まだコミットしたくない変更を一時的によけて、作業中のファイルを直前のコミットの状態に戻せます。よけた変更は、あとで git stash pop で元に戻せます。

補足

検証環境は Ubuntu 24.04、Git 2.43.0 です。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定し、出力が毎回同じになるよう、コミットの日時を環境変数で決めました。リポジトリは手元に作ったものだけで、リモートとのやり取りは試していません。Windows・macOS でも試していません。

変更があってブランチを切り替えられないとき

main ブランチで index.html に1行足し、まだコミットしていない状態です。ここで、同じ index.html を別の内容でコミットしてある hotfix ブランチに切り替えようとすると、Git に止められます。

console
$ git status --short
 M index.html

$ git switch hotfix
error: Your local changes to the following files would be overwritten by checkout:
	index.html
Please commit your changes or stash them before you switch branches.
Aborting

メッセージのとおり、変更をコミットするか stash するよう求められます。書きかけの変更をコミットしたくないときは、git stash でよけます。

console
$ git stash
Saved working directory and index state WIP on main: ba50b1e 最初のコミット

$ git status
On branch main
nothing to commit, working tree clean

$ git stash list
stash@{0}: WIP on main: ba50b1e 最初のコミット

$ cat index.html
<h1>ねこノート</h1>

index.html は足した行が消え、直前のコミット(ba50b1e)と同じ内容に戻りました。よけた変更は git stash list に stash@{0} として残っています。この状態なら、ブランチを切り替えられました。

console
$ git switch hotfix
Switched to branch 'hotfix'

$ git switch main
Switched to branch 'main'

git stash pop でよけた変更を戻す

main に戻ってから git stash pop を実行すると、よけた変更が作業中のファイルに戻り、一覧からは消えます。

console
$ git stash pop
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   index.html

no changes added to commit (use "git add" and/or "git commit -a")
Dropped refs/stash@{0} (46113263a6792c883cbc2f408787daa37d5c53eb)

$ cat index.html
<h1>ねこノート</h1>
<p>新しい記事の一覧</p>

$ git stash list

git stash の公式リファレンスによると、引数なしの git stash は git stash push と同じです。よけた変更は新しいものほど上に積まれ、最新が stash@{0}、その1つ前が stash@{1} です。

git stash で作業中のファイルの変更が一覧に入り、pop と apply で戻る。一覧は新しいものが上で、pop は戻したあと一覧から消し、apply は一覧に残す。pop で衝突したときは一覧に残る
git stash でよけた変更の行き先と、pop・apply の違い

新しく作ったファイルは -u を付けないとよけられない

Git がまだ追跡していないファイル(一度も git add していないファイル)は、git stash だけではよけられません。index.html の変更に加えて、新しく memo.txt を作ってから試しました。

console
$ git status --short
 M index.html
?? memo.txt

$ git stash
Saved working directory and index state WIP on main: ba50b1e 最初のコミット

$ git status --short
?? memo.txt

index.html の変更はよけられましたが、memo.txt はそのまま残りました。いったん pop で戻してから、-u(--include-untracked)を付けてよけ直すと、memo.txt もフォルダから消えました。

console
$ git stash -u
Saved working directory and index state WIP on main: ba50b1e 最初のコミット

$ git status --short

$ ls
README.md
index.html

$ git stash show --include-untracked
 index.html | 1 +
 memo.txt   | 1 +
 2 files changed, 2 insertions(+)

git stash show に --include-untracked を付けると、よけた中身に memo.txt が入っていることを確かめられます。このあと git stash pop すると、index.html の変更と memo.txt の両方が戻りました。

メッセージを付けて、いくつもよける

よけた変更は、何もしなければ WIP on main: ... という名前で一覧に並びます。いくつもよけると見分けにくいので、git stash push -m で説明を付けておくと便利です。index.html の変更と、README.md の変更を、順に別々によけました。

console
$ git stash push -m '記事の一覧を追加'
Saved working directory and index state On main: 記事の一覧を追加

$ echo 'トップページは index.html です。' >> README.md

$ git stash push -m 'README に説明を追加'
Saved working directory and index state On main: README に説明を追加

$ git stash list
stash@{0}: On main: README に説明を追加
stash@{1}: On main: 記事の一覧を追加

あとからよけた「README に説明を追加」が stash@{0} になり、先によけたほうは stash@{1} に下がりました。中身は git stash show で確かめられます。-p を付けると、差分そのものが表示されます。

console
$ git stash show stash@{1}
 index.html | 1 +
 1 file changed, 1 insertion(+)

$ git stash show -p stash@{1}
diff --git a/index.html b/index.html
index e54fb8d..2c2575e 100644
--- a/index.html
+++ b/index.html
@@ -1 +1,2 @@
 <h1>ねこノート</h1>
+<p>新しい記事の一覧</p>

apply は戻しても一覧に残る

git stash apply も、よけた変更を戻すコマンドです。pop との違いは、戻したあとも一覧から消さないことです。番号を指定すれば、いちばん上以外も戻せます。

console
$ git stash apply stash@{1}
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   index.html

no changes added to commit (use "git add" and/or "git commit -a")

$ git stash list
stash@{0}: On main: README に説明を追加
stash@{1}: On main: 記事の一覧を追加

index.html の変更は戻りましたが、stash@{1} は一覧に残っています。もう要らなければ、git stash drop で一覧から消します。

console
$ git stash drop stash@{1}
Dropped stash@{1} (db0f8265a2ad15daf85ac1064e7e3f526e99902f)

$ git stash list
stash@{0}: On main: README に説明を追加

以降の節は、それぞれ前の節の変更を片付け、作業中のファイルに変更がなく、git stash list も空の状態から始めています。

一部のファイルだけよける

git stash push のあとに -- とファイル名を書くと、そのファイルの変更だけをよけられます。index.html と README.md の両方を変更した状態で、README.md だけをよけました。

console
$ git status --short
 M README.md
 M index.html

$ git stash push -m 'README だけ' -- README.md
Saved working directory and index state On main: README だけ

$ git status --short
 M index.html

index.html の変更は、作業中のファイルに残ったままです。

add した状態は、pop だけでは戻らない

index.html に1行足して add してからよけ、git stash pop で戻すと、変更の中身は戻りましたが、add していない状態になりました。

console
$ echo '<p>新しい記事の一覧</p>' >> index.html

$ git add index.html

$ git status --short
M  index.html

$ git stash
Saved working directory and index state WIP on main: ba50b1e 最初のコミット

$ git stash pop
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   index.html

no changes added to commit (use "git add" and/or "git commit -a")
Dropped refs/stash@{0} (d3f8d19049703dd3fa70f6314c490cd115f5376c)

$ git status --short
 M index.html

git status --short の M の位置が、左の列(add した変更)から右の列(add していない変更)に移っています。add した状態まで戻したいときは、--index を付けます。

console
$ git add index.html

$ git stash
Saved working directory and index state WIP on main: ba50b1e 最初のコミット

$ git stash pop --index
On branch main
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   index.html

Dropped refs/stash@{0} (ad6f944cd5e5a9a674581e590a6b60673fd30a1c)

$ git status --short
M  index.html

pop で衝突したときは、一覧に残る

よけている間に、同じファイルの同じ場所を変えてコミットすると、pop したときに衝突します。index.html の2行目に「新しい記事の一覧」を足してよけ、そのあと同じ2行目に「お知らせ」を足してコミットしてから pop しました。

console
$ git stash pop
Auto-merging index.html
CONFLICT (content): Merge conflict in index.html
On branch main
Unmerged paths:
  (use "git restore --staged <file>..." to unstage)
  (use "git add <file>..." to mark resolution)
	both modified:   index.html

no changes added to commit (use "git add" and/or "git commit -a")
The stash entry is kept in case you need it again.

$ git stash list
stash@{0}: WIP on main: ba50b1e 最初のコミット

$ cat index.html
<h1>ねこノート</h1>
<<<<<<< Updated upstream
<p>お知らせ</p>
=======
<p>新しい記事の一覧</p>
>>>>>>> Stashed changes

The stash entry is kept in case you need it again. と表示され、よけた変更は一覧に残りました。Updated upstream の側がコミットした内容、Stashed changes の側がよけていた内容です。公式リファレンスにも、衝突したときは一覧から消えないので、手で衝突を解決してから git stash drop を実行するよう書かれています。

両方の行を残す形に index.html を書き直し、git add してから drop しました。

console
$ printf '<h1>ねこノート</h1>\n<p>お知らせ</p>\n<p>新しい記事の一覧</p>\n' > index.html

$ git add index.html

$ git stash drop
Dropped refs/stash@{0} (75e93a433e3c9d37c0776d4252c3ddd9fd558036)

$ git stash list

$ git status --short
M  index.html

git add したので、index.html は add した状態です。drop しても、作業中のファイルは変わりません。

間違えて drop した変更を取り戻す

pop や drop で一覧から消すとき、Dropped refs/stash@{0} (...) のかっこの中に、stash を記録したコミットのハッシュが表示されます。公式リファレンスによると、apply には stash が作ったコミットであれば、一覧にないものも指定できます。index.html に1行足して git stash でよけ、すぐに drop しました。表示されたハッシュを git stash apply に渡すと、消した変更が戻りました。

console
$ echo '<p>新しい記事の一覧</p>' >> index.html

$ git stash
Saved working directory and index state WIP on main: c092d3b お知らせを追加

$ git stash drop
Dropped refs/stash@{0} (a08e548fed8dd6ee3a4a458629767d3e6c3e1f8e)

$ git stash list

$ git stash apply a08e548
On branch main
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   index.html

no changes added to commit (use "git add" and/or "git commit -a")

$ git status --short
 M index.html
注意

drop や、すべてを消す git stash clear で一覧から消した変更は、ふだんの安全策では取り戻せないと、公式リファレンスに書かれています。公式リファレンスの例には、git fsck --unreachable で消えた変更を探す方法もあります。消す前に git stash show -p で中身を確かめてください。

​Posted by 86