はじめに
Git は、開発者がプロジェクトのファイル履歴を管理するのに役立つ強力なバージョン管理システムです。時には、Git が追跡したくないファイルがリポジトリにキャッシュされることがありますが、ローカルディレクトリには保持しておきたい場合があります。 git rm --cached コマンドを使用すると、作業ディレクトリにファイルを保持したまま、Git の追跡システムからファイルを削除できます。このチュートリアルでは、このコマンドを効果的に使用して、リポジトリをクリーンアップし、ワークフローを最適化する方法を説明します。
サンプル Git リポジトリの作成
Git からキャッシュされたファイルを削除する方法を理解するために、まずいくつかのファイルを含むサンプルリポジトリを設定しましょう。これにより、Git のキャッシングが実際にどのように機能するかを確認できます。
Git キャッシングの理解
git add コマンドを使用してファイルを Git に追加すると、Git はこれらのファイルをインデックス (ステージングエリアとも呼ばれます) に保存します。これらのファイルは現在「キャッシュ」またはステージングされており、リポジトリにコミットされるのを待っています。ローカルファイルシステムからファイルを削除せずに、これらのファイルのステージングを解除したり、Git の追跡から削除したりしたい場合があります。
リポジトリの設定
作業用のシンプルな Git リポジトリを作成しましょう。
- LabEx VM 環境でターミナルウィンドウを開きます。
- プロジェクトディレクトリに移動します。
cd ~/project
- テストリポジトリ用の新しいディレクトリを作成します。
mkdir git-cache-demo
cd git-cache-demo
- 新しい Git リポジトリを初期化します。
git init
次のような出力が表示されるはずです。
Initialized empty Git repository in /home/labex/project/git-cache-demo/.git/
- Git ユーザー情報を設定します (コミットに必要です)。
git config user.name "LabEx User"
git config user.email "labex@example.com"
これで、ファイルを追加する準備ができた新しい Git リポジトリができました。次のステップでは、いくつかのファイルを作成し、Git の追跡システムに追加します。これにより、後でキャッシュから削除する練習をすることができます。
リポジトリへのファイルの追加
Git リポジトリを設定したので、いくつかのファイルを作成し、Git の追跡システムに追加しましょう。これにより、ファイルが Git で「キャッシュ」されることの意味を理解できます。
ファイルの作成と追加
- まず、リポジトリにいくつかの異なる種類のファイルを作成しましょう。
## Create a text file
echo "This is a sample text file" > sample.txt
## Create a config file
echo "debug=true" > config.ini
## Create a log file (which we typically don't want to track)
echo "2023-01-01: System started" > app.log
- リポジトリのステータスを確認します。
git status
次のような出力が表示されるはずです。
On branch master
No commits yet
Untracked files:
(use "git add <file>..." to include in what will be committed)
app.log
config.ini
sample.txt
nothing added to commit but untracked files present (use "git add" to track)
これは、Git が認識しているファイルが 3 つあるものの、まだ追跡されていないことを示しています。
- すべてのファイルを Git のステージングエリア (キャッシュ) に追加しましょう。
git add .
- もう一度ステータスを確認します。
git status
これで、次のように表示されるはずです。
On branch master
No commits yet
Changes to be committed:
(use "git rm --cached <file>..." to unstage)
new file: app.log
new file: config.ini
new file: sample.txt
Git が、git rm --cached <file> を使用してファイルのステージングを解除できることを教えていることに注意してください。ファイルは現在 Git のステージングエリアにキャッシュされており、コミットされるのを待っています。
- これらのファイルをコミットして、リポジトリの履歴の一部にしましょう。
git commit -m "Initial commit with sample files"
これで、Git の追跡システムにファイルを正常に追加できました。次のステップでは、ローカルディレクトリにファイルを保持したまま、Git のキャッシュから特定のファイルを削除する方法を学びます。
Git のキャッシュから単一ファイルを削除する
Git によって追跡されているファイルがあるので、ローカルディレクトリにファイルを保持したまま、Git の追跡から特定のファイルを削除する方法を学びましょう。これは、ログファイル、一時ファイル、または機密情報を含むファイルなど、除外する必要があるファイルを誤ってコミットした場合によく必要になります。
Git のキャッシュからファイルを削除する理由
Git のキャッシュからファイルを削除する理由はいくつかあります。
- 機密情報を含むファイルを誤って追加してしまった
- ログやコンパイル済みファイルなどの大きなバイナリファイルを除外したい
.gitignoreファイルを設定していて、すでに追跡されているファイルを削除する必要がある
app.log を Git の追跡から削除する
app.log ファイルを Git で追跡すべきではないことに気づいたとしましょう。
- まず、Git が現在ファイルを追跡していることを確認しましょう。
git ls-files
3 つのファイルすべてがリストに表示されるはずです。
app.log
config.ini
sample.txt
- 次に、ローカルディレクトリにファイルを保持したまま、
app.logを Git の追跡システムから削除しましょう。
git rm --cached app.log
確認メッセージが表示されます。
rm 'app.log'
- もう一度ステータスを確認します。
git status
app.log が追跡されていないファイルとしてリストされていることがわかります。
On branch master
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
deleted: app.log
Untracked files:
(use "git add <file>..." to include in what will be committed)
app.log
これは、Git が次のコミットでファイルの追跡を停止することを意味しますが、ファイルはまだローカルディレクトリに存在します。
- ファイルがまだ作業ディレクトリに存在することを確認しましょう。
ls -la
app.log がまだそこにあることがわかるはずです。
- この変更をコミットして、Git の追跡からファイルの削除を完了します。
git commit -m "Remove app.log from Git tracking"
- Git がファイルを追跡しなくなったことを確認します。
git ls-files
これで、次だけが表示されるはずです。
config.ini
sample.txt
ただし、app.log ファイルはまだローカルディレクトリに存在します。
cat app.log
出力：
2023-01-01: System started
おめでとうございます！ローカルディレクトリにファイルを保持したまま、Git のキャッシュからファイルを正常に削除しました。次のステップでは、複数のファイルを処理し、.gitignore を使用してワークフローを改善する方法を学びます。
複数のファイルとディレクトリの操作
Git のキャッシュから単一ファイルを削除する方法がわかったので、複数のファイルやディレクトリ全体を削除するなど、より複雑なシナリオを検討しましょう。
実践のためのファイルの追加
まず、練習用にさらにいくつかのファイルとディレクトリ構造を作成しましょう。
- ディレクトリといくつかの追加ファイルを作成します。
## Create a directory for temporary files
mkdir temp
## Create some files in the temp directory
echo "This is a temporary file" > temp/temp1.txt
echo "Another temporary file" > temp/temp2.txt
## Create another log file in the main directory
echo "2023-01-02: System updated" > system.log
- これらの新しいファイルを Git の追跡に追加します。
git add .
- 変更をコミットします。
git commit -m "Add temporary files and system log"
- Git がすべてのファイルを追跡していることを確認します。
git ls-files
次のように表示されるはずです。
app.log
config.ini
sample.txt
system.log
temp/temp1.txt
temp/temp2.txt
Git のキャッシュから複数のファイルを削除する
次に、すべてのログファイルと temp ディレクトリ全体を Git の追跡から削除するとします。
- ログファイルを Git の追跡から削除します。
git rm --cached system.log
- temp ディレクトリ内のすべてのファイルを再帰的に削除します。
git rm --cached -r temp/
ここで -r フラグは重要です。これは、Git にディレクトリ内のすべてのファイルをそのキャッシュから再帰的に削除するように指示します。
- ステータスを確認します。
git status
ログファイルと temp ディレクトリ内のすべてのファイルの両方が、Git の追跡システムからの削除のためにステージングされていることがわかります。
On branch master
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
deleted: system.log
deleted: temp/temp1.txt
deleted: temp/temp2.txt
Untracked files:
(use "git add <file>..." to include in what will be committed)
system.log
temp/
- これらの変更をコミットします。
git commit -m "Remove logs and temp directory from Git tracking"
- Git がこれらのファイルを追跡しなくなったことを確認します。
git ls-files
これで、次だけが表示されるはずです。
app.log
config.ini
sample.txt
ただし、すべてのファイルはまだローカルディレクトリに存在します。
ls -la
ls -la temp/
.gitignore を使用して不要なファイルの追跡を防止する
ファイルを Git の追跡から削除したので、誤って再び追加されないように、.gitignore ファイルを設定しましょう。
.gitignoreファイルを作成します。
nano .gitignore
- 次のパターンをファイルに追加します。
## Ignore log files
*.log
## Ignore temp directory
temp/
保存して終了します (Ctrl+X、次に Y、次に Enter を押します)。
.gitignoreファイルを追加してコミットします。
git add .gitignore
git commit -m "Add .gitignore file"
これで、すべてのファイルを Git に追加しようとしても、.gitignore ファイルが尊重され、指定されたパターンは追跡されません。
git add .
git status
ログファイルと temp ディレクトリが Git の追跡に追加されていないことがわかります。
これで、Git のキャッシュから複数のファイルとディレクトリを削除する方法、および .gitignore ファイルを使用して特定のファイルが将来追跡されないようにする方法を学びました。
高度なテクニックとベストプラクティス
Git のキャッシュからファイルを削除する基本を理解したので、ワークフローを改善するための高度なテクニックとベストプラクティスをいくつか見ていきましょう。
一つのステップでファイルの削除と無視
Git によってすでに追跡されているファイルがあり、追跡から削除し、.gitignore ファイルに追加したい場合は、この効率的なアプローチを使用できます。
- 無視したい新しいファイルタイプを作成しましょう。
## Create a build directory with some compiled files
mkdir build
echo "Compiled binary data" > build/app.bin
echo "Configuration for build" > build/build.conf
- これらのファイルを Git に追加します。
git add build/
git commit -m "Add build files temporarily"
- 次に、Git の追跡から削除し、
.gitignoreファイルを 1 つのワークフローで更新しましょう。
## First, edit the .gitignore file to add the build directory
echo "## Ignore build directory" >> .gitignore
echo "build/" >> .gitignore
## Now remove the tracked files from Git's cache
git rm --cached -r build/
## Commit both changes together
git add .gitignore
git commit -m "Remove build directory from tracking and add to .gitignore"
- ファイルが追跡されなくなったが、ローカルにはまだ存在することを確認します。
git ls-files
ls -la build/
機密情報の取り扱い
パスワードや API キーなどの機密情報を含むファイルを誤ってコミットした場合、Git のキャッシュから削除することは最初のステップにすぎません。Git はすべてのコミットの履歴を保持しているため、機密情報はまだリポジトリの履歴に存在します。
機密情報については、以下を行う必要があります。
- 習得したように、Git のキャッシュからファイルを削除する
- 侵害されたパスワードまたはキーを変更する
git filter-branchや BFG Repo-Cleaner などのツールを使用して、履歴から機密データを削除することを検討する
これはこのチュートリアルの範囲を超えていますが、この制限を認識しておくことが重要です。
Git キャッシュ管理のベストプラクティス
従うべきベストプラクティスを次に示します。
プロジェクトの早い段階で適切な
.gitignoreファイルを作成する: これにより、不要なファイルが誤って追跡されるのを防ぎます。一般的なパターンにはグローバル
.gitignoreファイルを使用する: すべてのリポジトリに適用されるグローバル.gitignoreファイルを設定できます。
git config --global core.excludesfile ~/.gitignore_global
git add .に注意する: このコマンドは、追跡されていないすべてのファイルを追加します。可能な場合は、git add <file>のようなより具体的なコマンドを使用します。コミット前に変更を確認する: 常に
git statusとgit diff --cachedを使用して、コミットしようとしている内容を確認します。一般的な操作にはエイリアスを使用する: たとえば、キャッシュされたファイルを削除するためのエイリアスを設定できます。
git config --global alias.uncache 'rm --cached'
次に、次のように使用できます。
git uncache <file>
これらのテクニックとベストプラクティスを使用すると、クリーンで効率的なリポジトリを維持するために、Git のキャッシュを効果的に管理する方法を包括的に理解できるようになりました。
まとめ
このチュートリアルでは、git rm --cached コマンドを効果的に使用して、ローカルディレクトリにファイルを保持しながら、Git の追跡システムからファイルを削除する方法を学びました。達成した内容は次のとおりです。
- Git リポジトリを設定し、Git キャッシュの概念について学習しました。
- Git の追跡システムにファイルを追加しました。
git rm --cachedを使用して、Git のキャッシュから個々のファイルを削除しました。- 再帰オプション (
-r) を使用して、複数のファイルとディレクトリを管理しました。 .gitignoreを使用して、不要なファイルが追跡されるのを防ぎました。- Git のキャッシュを管理するための高度なテクニックとベストプラクティスを検討しました。
これらのスキルは、クリーンで効率的な Git リポジトリを維持し、不要なファイルの追跡を防ぎ、機密情報を保護するのに役立ちます。Git がどのファイルを追跡するかを適切に管理することで、一時ファイル、ログ、ビルド成果物を無視しながら、重要なコードと設定ファイルに集中できます。
Git のキャッシュからファイルを削除しても、ローカルファイルシステムからファイルが削除されるわけではないことに注意してください。Git に追跡を停止するように指示するだけです。これは、リポジトリの内容を管理し、必要なファイルのみがプロジェクトの履歴に含まれるようにするための強力なツールです。
