Git で管理するプロジェクトには、プロジェクトに関係のないファイルや、一時的に作成したファイルなど、Git の管理対象から外したいファイルが存在する場合があります。
Git の管理からファイルを外すには、以下の 2 つの方法があります。
- .gitignore ファイルにファイルを追加する
- git rm –cached コマンドを実行する
.gitignore ファイルにファイルを追加する
.gitignore ファイルは、Git で管理しないファイルを指定するファイルです。このファイルにファイルを追加すると、そのファイルは Git の管理対象から外されます。
.gitignore ファイルは、リポジトリのルートディレクトリに作成する必要があります。ファイル名は必ず .gitignore とする必要があります。
.gitignore ファイルにファイルを追加するには、以下の手順を実行します。
- テキストエディタで .gitignore ファイルを開く。
- ファイルに管理対象から外したいファイルのパターンを追加する。
- ファイルを保存する。
ファイルのパターンには、ワイルドカードを使用できます。たとえば、以下のパターンを追加すると、すべての .txt ファイルが Git の管理対象から外されます。
*.txt
git rm –cached コマンドを実行する
git rm –cached コマンドは、既に Git の管理対象となっているファイルを、Git の管理対象から外すコマンドです。
git rm –cached コマンドを実行すると、ファイルはローカルディレクトリから削除されません。ただし、Git の管理対象から外されるため、コミットやプッシュができなくなります。
git rm –cached コマンドを実行するには、以下の手順を実行します。
- 管理対象から外したいファイルをローカルディレクトリから削除する。
- git rm –cached コマンドを実行する。
たとえば、以下のコマンドを実行すると、sample.txt ファイルが Git の管理対象から外されます。
git rm --cached sample.txt
注意点
.gitignore ファイルにファイルを追加する場合、そのファイルは Git の管理対象から外されますが、ローカルディレクトリから削除されません。そのため、誤って .gitignore ファイルに追加してしまった場合は、ローカルディレクトリからファイルを削除する必要があります。
git rm –cached コマンドを実行する場合、ファイルはローカルディレクトリから削除されません。ただし、Git の管理対象から外されるため、コミットやプッシュができなくなります。そのため、誤って git rm –cached コマンドを実行してしまった場合は、元に戻す必要があります。
まとめ
Git の管理からファイルを外すには、以下の 2 つの方法があります。
- .gitignore ファイルにファイルを追加する
- git rm –cached コマンドを実行する
どちらの方法を使用するかは、ファイルの管理方法によって異なります。