git stash -uは、追跡済みファイルの変更に加え、未追跡ファイルも一時退避する指定です。無視対象まで含める指定とは異なります。作業を切り替える前に、何が退避され、何が作業場所に残るかを確認しましょう。
ここではGitの公式仕様に基づく手順を整理します。コマンドは説明用の未実行例です。
追跡済み・未追跡・無視対象を分ける
Gitの管理対象として追跡されているファイルと、まだ追跡していないファイルは別です。さらに、未追跡ファイルの中でもignore規則で除外されるものがあります。git stash push -uの-uは--include-untrackedを意味し、無視対象まで含める--allとは区別されます。Gitのオプション説明
| 作業物 | 通常のpush | push -u |
|---|---|---|
| 追跡済みファイルの変更 | 対象 | 対象 |
| 未追跡で無視されないファイル | 対象外 | 対象 |
| 無視対象のファイル | 対象外 | 対象外 |
たとえばソースの修正と新規テストファイルをまとめて退避したいなら、未追跡のテストが含まれるかを確かめます。ビルド成果物まで一律に退避する必要があるとは限りません。
退避前の一覧を残す
まず現在の状態を確認し、残したいファイルを把握します。
git status --short
git diff --stat
git diff --cached --stat
これは退避対象を検討する例です。ignoreされた設定ファイルや生成物は通常の状態表示に出ないこともあるため、重要な作業物を表示結果だけで把握できたと考えないでください。
退避は作業を切り替えるための一時保存として使い、重要な成果物の唯一の保管先にしないことを勧めます。共有や長期保存が必要な変更は、内容を確認したうえで適切なコミットや別の保管手段を検討します。
用途が分かるメッセージを付ける
対象が確認できたら、何の作業か分かる名前を付けて退避します。
git stash push -u -m 'order-validation-work'
git status --short
git stash list
退避後は、コマンドが成功したことに加え、現在の作業場所が予定どおりか、記録が一覧へ追加されたかを確認します。-uでは対象の未追跡ファイルが退避後の作業場所から除かれるため、ファイルが見えなくなることと紛失を混同しないようにします。
復元前に退避内容を確かめる
git stash showには、未追跡ファイルも差分へ含める-uがあります。新しい退避記録を作るたびに番号の意味が変わり得るため、復元時点の一覧を見直します。
git stash show -u --stat 'stash@{0}'
差分には機密値が含まれる可能性があるので、確認結果をそのまま外部へ貼り付けないでください。復元対象と切替先が確定してから、applyまたはpopを選びます。
切替前の確認と組み合わせる
退避の目的は、元の作業を見失わず別の変更へ移ることです。対象ファイル・作業名・復元先を一組で残すと、途中作業を説明できます。Gitのブランチ作成と切り替えも併せて確認してください。