【🔰初心者向け】Git入門 [revert, restore, stash]

はじめに

こんにちは！ITスクールRareTECHにてCS（Customer Support）を担当している池村です。今回の記事はGitコマンドの続きの記事となります。

前の記事はこちら👇

revertコマンドについて

前回の記事で、reset周りの解説をしました。revertもresetに近いお仕事をしてくれるコマンドになります。ただ、明確にresetコマンドと違うところは、取り消したということをコミットとして残してくれるところです。

resetの場合の動作は以下になります

resetの場合、コミット4はなくなります。

revertの場合の動作は以下になります

パッとみてもよくわからないと思いますので、実際にコマンドを叩いて確認していきましょう。

revertの使い方

今回の環境は、こちらの記事までで作成したリポジトリを使っております。

※ブランチはtest-branch1を利用しています。
では何かしらのファイルを追加してみましょう。

ファイルを追加する

echo 'Hello Git!!' >> test3.txt

さて、addとcommitでローカルの変更を確定します。

使い方

git add .
git commit -m "test3.txtを作成し、Hello Gitを書き込んだ"

この状態でgit logを確認すると、以下のようになっているはずです。

さて、この状態でrevertコマンドを使ってみましょう。

使い方

git revert HEAD

revertコマンドを実行すると、上記のようにコミットメッセージを編集できるファイルが開かれます。

今回は少しメッセージを編集します。基本的にVimの操作になるので、iでインサートモードにしてから、Revert "test3.txtを作成し、Hello Gitを書き込んだ"の""で囲まれた部分を編集してみます。

revertでtest3.txtを削除してやり直しと書き直しました。書き込みが終わったら、escキーを押して、:wqでファイルを閉じてください。

git logで確認してみましょう。

ついでにlsコマンドを実行して、test3.txtがどうなっているのかも確認してみましょう。

新しいコミットが作られているのを確認しました。
resetと違うのは、元のtest3.txtを作成したコミットも残っているところです。ですので、そちらにresetで戻ることもできるし、再度revertをして元に戻すこともできます。

コミットメッセージなどを編集しない場合は、以下のオプションで可能です。

使い方

git revert HEAD --no-edit

コミットIDを利用して、いくつか前の状態に戻すことも可能

revertはコミットIDを指定して戻すこともできます。今回はコミットIDb52e5dcce07541340ec0d1354b95120af4671fadに戻ろうと思います。

使い方

git revert b52e5d

こうすることで、リモートの状態と同じにすることができました。また最初からやり直しですね。

とはいえ、resetと違って、やり直し前に戻ることができるのは安心だと思います。

注意点として、revertはブランチがクリーンな状態（ステージングしていないファイル等がない）でしか実行できません。

restoreコマンドについて

先ほどまではコミット単位のやり直しのお話でした。このrestoreコマンドは、作業ツリーの変更を取り消すためのコマンドです。ですので、コミット前のファイルの変更を取り消すために使われます。

このコマンドは取り扱いに注意が必要です。作業した内容が失われます。

ファイルを色々変更していると、このファイルの変更だけ元に戻したいな〜となることがあります。その際にはrestoreコマンドを使っていきましょう。
では使い方をみていきます。
今回は、test3.txtに文字列を書き込んで、その変更をリセットしていきます。

restoreの使い方

# ファイルに変更を加える
echo 'Test Restore!!' >> test3.txt 

# ファイルの中身を確認
cat test.3txt

# ステータスも確認
git status

# 変更を取り消す
git restore test3.txt

実行結果👇

今回は1文しか追加していませんが、基本的にファイル単位での取り消しになりますので、注意が必要です。

ステージングを解除する

では次に間違ってaddをしてしまった場合です。ステージングされたファイルをステージから降ろすことが可能です。

ステージングから解除する場合

# 再度ファイルを変更する
echo 'Test Restore!!' >> test3.txt 

# ステージングする
git add .

# ステータスを確認
git status

# ステージングを解除
git restore --staged test3.txt

# ステータスを確認
git status

実行結果👇

reset --mixedの場合は、ステージングされたファイルを全て解除できますが、個別に解除するならrestore --stagedを使いましょう。

特定のコミットの状態まで戻す場合

コミットを元に、ファイルの状態を戻すこともできます。

コミットIDを元にファイルの状態を戻す

git restore --source <コミットID> 戻したいファイル名

もちろん、そのコミットの状態をしっかり確認した上で実行してください。

全てなかったことにする

この使い方が一番危険ではあるのですが、ご紹介します。

全部消しちゃえってコマンド

git restore .

慎重にファイルごとrestoreしないと、全て消えてしまうので大変です。完全に復元不可というわけではありません。（状況によっては復元可能）使う時は自己責任でお願いします。。

stashコマンドについて

次にstashコマンドについてご紹介します。
これは、現在の編集した変更部分を一時的に待避してくれるコマンドです。
早速使い方をみていきましょう。

使い方

# 1文追加する
echo 'Test Stash!!' >> test3.txt  

# ファイルの中身を確認
cat test3.txt

# ステータスも確認
git status

# stashする
git stash

# ファイルの中身とステータスを確認
cat test3.txt
git status

実行結果👇

さて、うまくコマンドが実行されているのであれば、変更はなくなっているはずです。一時待避させた状態であれば、違うブランチに移動したり、そのブランチがクリーンな状態で、新しいブランチを切ったりが可能になります。

一時退避した変更部分を再度持ってくる

さて、stashはあくまで退避なので、復元することも可能です。
先ほどの実行後、退避した内容を確認してみましょう。

stashのリストを確認

git stash list

# 実行結果
stash@{0}: WIP on test-branch1: 56fca9b test3.txtを作成し、Hello Gitを書き込んだ

stash@{0}

これは最新のstashを指しています。{}の中の数字で違う。

WIP on test-branch1

作業途中（Work In Progress）のstashで、test-branch1というブランチ上で作成

56fca9b

stashを作成した時点での最新コミットのハッシュ値

test3.txtを作成し、Hello Gitを書き込んだ

stash時に付けた説明文（メッセージ）。何もつけないと、最新のコミットメッセージになります。

復元方法

退避した内容をファイルに復元していきましょう。

復元方法

git stash pop

実行結果👇

元に戻って、まだaddしてないですよ！と言われています。ファイルの内容も元に戻っていますね。

よく使う使い方

先ほどのシンプルなstashはあまり使わないので、以下によく使うやり方を残しておきます。

使い方

git stash save "test3.txtの変更を一時的に退避"

saveを使うと、stashのメッセージを残すことができます。

実行結果👇

メッセージもわかりやすくなっているのがわかりますね。

注意点

stashで同じファイルの変更点を別々に退避させた場合、復元の際にコンフリクトを起こす可能性が高まります。

コンフリクトを起こす場合

# 退避させている状態でファイルを再度編集してstashさせる
echo 'Test Stash2!!' >> test3.txt  

git stash save "test3.txtの変更を一時的に退避2"

# 1回目は成功
git stash pop

git add .

# 2回目
git stash pop

Auto-merging test3.txt
CONFLICT (content): Merge conflict in test3.txt
On branch test-branch1
Unmerged paths:
  (use "git restore --staged <file>..." to unstage)
  (use "git add <file>..." to mark resolution)
        both modified:   test3.txt

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

ファイルの中身を見てみると、、

コンフリクトを解消させるため、2,4,6行を削除して、再度addをして終了です。
この例はかなり簡単なファイル内容でしたが、複雑なコードの中では取扱注意です。

popとapplyの違い

git stash popを行うと、退避していた内容は消えてしまいます。退避した内容を消さずに、復元をしたい場合はgit stash applyを使います。

使い方

# 再度ファイルを編集
echo 'Test Stash3!!' >> test3.txt 

# 退避
git stash save "test3.txtにTest Stash3という文字列を追加した"

# 退避したstashを残しつつ復元
git stash apply

# stash listを確認
git stash list

実行結果👇

特定のファイルの変更分だけstashしたい場合

先ほどまでの例では、一つのファイルの変更点だけ扱っていましたが、複数ファイルの変更があった場合、かつ1つのファイルだけ指定してstashしたい場合があります。

一つのファイルだけstashしたい場合

git stash push -m "わかりやすいメッセージ" ファイル名

-mをつけないと、メッセージは残されず、自動で最新のコミットメッセージになりますのでご注意ください。

stashを消したい場合

stashを個別に消したい場合、専用のコマンドがあります。

stashの消し方

git stash drop stash@{番号}

まとめて消したい場合は以下のコマンドでできます。

stashをまとめて消す

git stash clear

取り扱い注意です。特にclearの方です。

差分を見てから復元したい場合

復元をする際に差分がみたい場合があると思います。
その際は、以下のコマンドで確認してみましょう。

差分の確認

git stash show -p stash@{番号}

stashコマンドのまとめ

stashコマンドはオプション系がかなりあるので、こちらにまとめを残しておきます。

コマンド	説明
git stash save "説明"	説明つきで退避
git stash push -m "説明"	ファイル単位で説明つきで退避
git stash list	スタッシュ一覧を確認
git stash pop	スタッシュを適用して、スタッシュは削除
git stash apply	スタッシュを適用するが、削除しない
git stash drop stash@{番号}	指定スタッシュを削除
git stash clear	全スタッシュを削除
git stash show -p stash@{番号}	差分を詳細に表示（番号指定をしないと、最新のものと差分をみる）

おわりに

ここまで読了、お疲れ様でした。
この辺りのコマンドはかなり大事ですが、結構覚えるの大変なんですよね。でもしっかりコマンドを叩いてみて、挙動を確認することが大事です。Gitを使わない開発現場なんて、ほぼないですからね。この辺りをしっかり押さえれば、初学者の方でも実際の現場で喰らいつけると思います！

それでは次回の記事はちょっとニッチなコマンドもご紹介しようと思います。