Gitで間違えてコミットしたファイルを追跡から外す方法

​​Git​コマンドライン

.env や node_modules/、ログファイルを間違えてコミットしてしまったときは、.gitignore に書くだけでは足りません。git rm --cached で Git の追跡から外し、その変更をコミットすると、手元のファイルは残したまま、次のコミットからは入らなくなります。パスワードや API キーの入った設定ファイルや、ビルドの成果物をコミットしないようにしたいときの手順です。検証環境で、操作の前と後の出力を確かめました。

補足

検証環境は Ubuntu 24.04、Git 2.43.0 です。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定し、コミットの日時は環境変数 GIT_AUTHOR_DATE と GIT_COMMITTER_DATE で決めました。.env の中身はダミーの値です。共有のリポジトリは、同じ環境の中に作ったベアリポジトリで代わりにしました。GitHub などのホスティングサービスや、Windows・macOS では試していません。

例のリポジトリ:.env と node_modules とログをコミットしてしまった

app.js のほかに、.env、debug.log、node_modules/left-pad/index.js を、git add . でまとめてコミットしてしまった状態から始めます。git ls-files は、Git が追跡しているファイルの一覧を表示します。

console
$ git add . && git commit -q -m "最初のコミット"

$ git ls-files
.env
app.js
debug.log
node_modules/left-pad/index.js

.gitignore に書くだけでは、追跡は止まらない

まず、外したい3種類を .gitignore に書きます。

console
$ cat .gitignore
.env
node_modules/
*.log

$ git status
On branch main
Untracked files:
  (use "git add <file>..." to include in what will be committed)
	.gitignore

nothing added to commit but untracked files present (use "git add" to track)

この状態で .env と debug.log を書き換えると、git status には変更として出てきます。git add -n .(実際には add せず、add されるファイルを表示する)を実行すると、.env と debug.log もステージに入ることが分かります。

console
$ printf "API_KEY=dummy-key-2\n" > .env && printf "more\n" >> debug.log

$ git status --short
 M .env
 M debug.log
?? .gitignore

$ git add -n .
add '.env'
add 'debug.log'
add '.gitignore'

gitignore の公式リファレンスには、.gitignore は追跡していないファイルを無視するためのもので、すでに追跡しているファイルには効かないと書かれています。一度コミットしたファイルは「追跡しているファイル」なので、.gitignore に書いても扱いは変わりません。

なお、新しく作ったログファイルには .gitignore が効いています。other.log を作っても、git status --short には出ませんでした。

console
$ printf "new\n" > other.log && git status --short && rm other.log
 M .env
 M debug.log
?? .gitignore

.gitignore に書いたのに外れていないファイルを探す

.gitignore の規則に当てはまるのに、追跡されたままのファイルは、git ls-files に -c(追跡しているファイル)、-i(無視の規則に当てはまるものだけ)、--exclude-standard(.gitignore などの標準の規則を使う)を付けると一覧にできます(git ls-files の公式リファレンス)。

console
$ git ls-files -ci --exclude-standard
.env
debug.log
node_modules/left-pad/index.js

規則が当たっているかを調べる git check-ignore -v は、追跡しているファイルについては何も表示しません。公式リファレンスにも、追跡しているファイルは無視の規則の対象にならないので表示しない、とあります。--no-index を付けると、.gitignore の何行目のどの規則に当てはまるかが表示されました(git check-ignore の公式リファレンス)。

console
$ git check-ignore -v .env; echo "exit=$?"
exit=1

$ git check-ignore -v --no-index .env debug.log node_modules/left-pad/index.js
.gitignore:1:.env	.env
.gitignore:3:*.log	debug.log
.gitignore:2:node_modules/	node_modules/left-pad/index.js

git rm –cached で追跡から外す

git rm に --cached を付けると、ステージ(インデックス)からだけファイルを取り除き、作業ツリーのファイルは変更があってもなくてもそのまま残します(git rm の公式リファレンス)。フォルダを外すときは -r も付けます。先に -n を付けて、何が外れるかを確かめておくと安心です。-n のときは、表示だけで何も変わりません。

console
$ git rm -n -r --cached .env debug.log node_modules
rm '.env'
rm 'debug.log'
rm 'node_modules/left-pad/index.js'

$ git rm -r --cached .env debug.log node_modules
rm '.env'
rm 'debug.log'
rm 'node_modules/left-pad/index.js'

git status では、3つのファイルが「コミットする予定の削除(deleted:)」になります。それでも、手元のファイルは消えていません。.env の中身も、書き換えたあとの内容のままです。

console
$ git status
On branch main
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	deleted:    .env
	deleted:    debug.log
	deleted:    node_modules/left-pad/index.js

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	.gitignore


$ ls -A
.env
.git
.gitignore
app.js
debug.log
node_modules

$ cat .env
API_KEY=dummy-key-2

.gitignore も一緒にコミットします。追跡しているファイルは .gitignore と app.js だけになりました。

console
$ git add .gitignore && git commit -q -m "追跡しないファイルを .gitignore に入れる"

$ git ls-files
.gitignore
app.js

$ git ls-files -ci --exclude-standard

このあと .env や debug.log を書き換えても、git status には何も出ず、git add -n . も何も表示しなくなりました。git check-ignore -v も、--no-index なしで規則を表示するようになります。

console
$ printf "API_KEY=dummy-key-3\n" > .env && printf "even more\n" >> debug.log

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

$ git add -n .

$ git check-ignore -v .env debug.log node_modules/left-pad/index.js
.gitignore:1:.env	.env
.gitignore:3:*.log	debug.log
.gitignore:2:node_modules/	node_modules/left-pad/index.js
上の箱は追跡しているファイル(コミット済みの .env)。.gitignore に書いても効かず、書き換えると git status に変更として出て、git add . でステージに入る。ピンクの矢印で git rm --cached .env してコミットすると、下の箱の追跡していないファイルになる。書き換えても git status に出ず、git add . でもステージに入らず、手元のファイルは残り、前のコミットには中身が残る
git rm –cached の前と後で、.gitignore の効き方が変わる

–cached を付け忘れると、手元のファイルも消える

--cached を付けずに git rm を実行すると、ステージからだけでなく、手元のファイルも消えます。debug.log だけをコミットした別のリポジトリで試したところ、git rm debug.log のあとで debug.log はなくなっていました。

console
$ git rm debug.log
rm 'debug.log'

$ ls -A
.git

コミットする前なら、git restore --staged でステージの削除を取り消してから git restore を実行すると、最後のコミットの内容でファイルが戻りました。

console
$ git restore --staged debug.log && git restore debug.log

$ cat debug.log
start
more

外したいファイルが多いときは、全部外してから add し直す

外したいファイルがたくさんあるときは、いったん全部のファイルを追跡から外し、git add . で入れ直す方法もあります。.gitignore に当てはまるファイルだけが、追跡から外れた状態になります。app.js、.env、debug.log をコミットした別のリポジトリに、.env と *.log を書いた .gitignore を置いて試しました。

console
$ git rm -r -q --cached . && git add . && git status
On branch main
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	deleted:    .env
	new file:   .gitignore
	deleted:    debug.log


$ ls -A
.env
.git
.gitignore
app.js
debug.log

変更のない app.js は、git status に出ていません。この方法では、.gitignore の書き方を間違えていると、外すつもりのなかったファイルまで外れます。コミットの前に git status で、deleted: のファイルが外したいものだけかを確かめてください。

前のコミットには、ファイルの中身が残っている

git rm --cached は、これからのコミットにファイルを入れないようにするだけです。前のコミットには、ファイルがそのまま残っています。git log にファイル名を渡すと、.env を追加したコミットと、追跡から外したコミットが表示されました。git show でコミットとファイル名を指定すると、最初にコミットした中身を取り出せました。

console
$ git log --oneline -- .env
c729766 追跡しないファイルを .gitignore に入れる
04245d9 最初のコミット

$ git show HEAD~1:.env
API_KEY=dummy-key-1
注意

パスワードや API キーなどをコミットして push してしまった場合、git rm --cached で外しても、そのリポジトリを見られる人は前のコミットから中身を読めます。GitHub のドキュメントにある、リポジトリから機密データを削除する手順の説明では、そのパスワードやトークンを無効にするか、新しいものに取り替えることを最初の手順としています。履歴から消す方法も同じページで説明されていますが、リポジトリをクローンしている全員との調整が必要になります。

ほかのクローンでは、pull するとファイルが消える

追跡から外したコミットを共有のリポジトリに push し、もう1つのクローンで pull しました。このコミットは、Git にとってはファイルを削除するコミットです。そのため、pull したクローンでは .env などが作業ツリーから消えました。

console
$ cat .env
API_KEY=dummy-key-1

$ git pull -q --ff-only origin main

$ git log --oneline
c729766 追跡しないファイルを .gitignore に入れる
04245d9 最初のコミット

$ ls -A
.git
.gitignore
app.js

$ cat .env
cat: .env: No such file or directory

.env のように、それぞれの手元に必要なファイルが消えた場合は、前のコミットから中身を取り出して置き直せます。git show で取り出せるのは、コミットされていた時点の中身です。git show の出力をファイルに書き出すだけなので、ステージには入りません。.gitignore に当てはまるため、git status にも出ませんでした。

console
$ git show HEAD~1:.env > .env

$ cat .env
API_KEY=dummy-key-1

$ git status
On branch main
Your branch is up to date with 'origin/main'.

nothing to commit, working tree clean

pull の前に .env を書き換えていた場合

まだ pull していない別のクローンで、.env を書き換えてから pull すると、pull は中止されました。手元の .env は、書き換えた内容のまま残っています。

console
$ printf "API_KEY=local-edit\n" > .env

$ git status --short
 M .env

$ git pull -q --ff-only origin main; echo "exit=$?"
error: Your local changes to the following files would be overwritten by merge:
	.env
Please commit your changes or stash them before you merge.
Aborting
exit=1

$ cat .env
API_KEY=local-edit

この場合は、.env をリポジトリの外にコピーしておき、git checkout -- .env で書き換えを捨ててから pull します。pull のあとでコピーを戻すと、書き換えた内容の .env が手元に戻り、git status --short には何も出ませんでした。

console
$ cp .env ../env-backup && git checkout -- .env && git pull -q --ff-only origin main; echo "exit=$?"
exit=0

$ cp ../env-backup .env && cat .env && git status --short
API_KEY=local-edit

​Posted by 86