Gitでバージョン管理をしていると、「空のディレクトリがコミットできない」という問題に直面することがあります。そんなときに役立つのが.gitkeepファイルです。
この記事では、Git初心者の方に向けて、.gitkeepファイルの役割や使い方を実例を交えながらわかりやすく解説します。
.gitkeepファイルとは？
.gitkeepは、空のディレクトリをGitリポジトリに含めるために使用するダミーファイルです。
通常、Gitはファイルの変更履歴を管理するシステムであり、ディレクトリそのものは追跡しません。そのため、空のディレクトリはGitで管理できないという特性があります。
この問題を解決するために、空のディレクトリ内に.gitkeepという名前のファイルを配置することで、間接的にディレクトリ構造を保持できるようになります。
なぜ空のディレクトリを管理する必要があるのか？
実際の開発現場では、以下のような理由で空のディレクトリを残しておきたいケースがあります。
1. ログファイルの保存先
アプリケーションが実行時にログファイルを書き込むディレクトリは、最初は空ですが必要な構造です。
project/
└── logs/ # アプリケーションがログを出力
└── .gitkeep
2. アップロードファイルの保存先
ユーザーがアップロードした画像やファイルを保存するディレクトリも、初期状態では空です。
project/
└── uploads/
├── images/
│ └── .gitkeep
└── documents/
└── .gitkeep
3. キャッシュやビルド出力用のディレクトリ
開発環境で一時ファイルやビルド結果を保存するディレクトリも同様です。
project/
└── cache/
└── .gitkeep
これらのディレクトリがないと、アプリケーションがエラーを起こす可能性があるため、プロジェクトのディレクトリ構造として管理しておく必要があります。
.gitkeepファイルの作成方法
実際に.gitkeepファイルを作成してみましょう。
ステップ1: ディレクトリを作成
まず、管理したい空のディレクトリを作成します。
mkdir logs
ステップ2: .gitkeepファイルを作成
そのディレクトリ内に.gitkeepファイルを作成します。
touch logs/.gitkeep
Windowsのコマンドプロンプトの場合：
type nul > logs\.gitkeep
ステップ3: Gitに追加してコミット
作成した.gitkeepファイルをGitに追加します。
git add logs/.gitkeep
git commit -m "Add logs directory with .gitkeep"
これで、空のディレクトリ構造がリポジトリに記録されます。
.gitkeepは公式機能ではない？
実は、.gitkeepという名前はGitの公式機能ではなく、開発者コミュニティで広く使われている慣習的な命名規則です。
つまり、ファイル名は.gitkeepでなくても構いません。以下のような名前でも同じ効果があります。
.gitignore（空のファイルとして）README.md（ディレクトリの説明を書く）.keepplaceholder.txt
ただし、.gitkeepという名前が最も一般的で、見た人が「これは空ディレクトリを管理するためのファイルだ」とすぐに理解できるため、この名前を使うことをおすすめします。
.gitkeepファイルの中身
.gitkeepファイルは通常、空のファイルとして作成されます。
しかし、以下のようにディレクトリの目的を説明するコメントを書いておくと、チーム開発でより親切です。
# このディレクトリについて
アプリケーション実行時にログファイルが出力されます。
ログファイル自体は.gitignoreで除外されています。
このように説明を書いておくことで、後から参加したメンバーもディレクトリの用途を理解しやすくなります。
.gitignoreとの組み合わせ
実際の開発では、.gitkeepと.gitignoreを組み合わせて使うことが多いです。
使用例：logsディレクトリ
logsディレクトリは残したいが、ログファイル自体はGitで管理したくない場合：
ディレクトリ構造：
logs/
└── .gitkeep
プロジェクトルートの.gitignore：
# ログファイルは無視するが、.gitkeepは除外しない
logs/*
!logs/.gitkeep
この設定により、logsディレクトリは保持されますが、ログファイル（.log）は管理対象から除外されます。
よくある質問（FAQ）
Q1: .gitkeepファイルを削除してもいいですか？
ディレクトリ内に他のファイルが追加されたら、.gitkeepは削除しても問題ありません。ただし、再び空になる可能性がある場合は残しておく方が無難です。
Q2: 複数のディレクトリに.gitkeepが必要ですか？
はい、空のまま管理したいディレクトリごとに.gitkeepファイルが必要です。
Q3: .gitkeep以外の名前でも大丈夫ですか？
技術的には問題ありませんが、.gitkeepという名前が一般的なので、それを使うことを推奨します。
まとめ
.gitkeepファイルは、Gitで空のディレクトリを管理するための便利な手法です。
この記事のポイント：
- Gitは空のディレクトリを追跡できない
.gitkeepファイルを配置することでディレクトリ構造を保持できる.gitkeepは慣習的な名前で、公式機能ではない- ログやアップロード先など、実行時に使用されるディレクトリの管理に便利
.gitignoreと組み合わせて使うことが多い
プロジェクトのディレクトリ構造を適切に管理することで、チーム開発がスムーズになり、環境構築時のエラーも防げます。ぜひ.gitkeepを活用してみてください。
