Gitはフォルダ自体を管理対象にはできない。空のフォルダを設定する手順

Gitでフォルダを監視対象にする手順

Gitはファイルを管理するがフォルダは管理できない

　
Gitで管理対象にする、しないの設定が記述されているファイルは .gitignoreです。
　
.gitignoreで無視フォルダの中の特定のファイルを除外「!（否定文）」を使う場合の注意点
　
上記の記事では、「.gitignore」を利用して管理対象外にしたフォルダの中のファイルを管理対象にする方法について解説しました。
　
ですが、Gitでは、フォルダ自体を管理対象にすることができません。
　
そのため、例えば、
・ログを出力するフォルダをあらかじめ作っておきたい
・ダウンロードするファイルを保管するフォルダを作っておきたい
　
と思っても、その中にファイルが入っていないと Gitで管理対象にすることができないのです。
　
　
そんなときは、
「.gitkeep」というファイルを作成し
そのファイルをフォルダの中に設置し
そのファイルを .gitignoreに記載する
と言う手順でフォルダを Gitの管理下に置く、という方法を採る必要があるのです。
　

　

Gitで空のフォルダを管理対象にする手順

手順１．「.gitkeep」というファイルを作成する

　
「.gitkeep」というファイルを作成します。
ファイルの中身は空（0バイト）のファイルで OKです。
　
　

手順２．Gitの管理下に置きたいフォルダの中に「.gitkeep」ファイルを置く

　
Gitの管理下に置きたいフォルダの中に「.gitkeep」ファイルを設置します。
　
　

手順３．.gitignoreに対象ファイルの設定を記述する

　
.gitignoreに、作成した .gitkeepを管理対象にする設定を記述します。
　
記述例としては以下の通りです。
　

!/tmp/download_file/
/tmp/download_file/*
!/tmp/download_file/.gitkeep

　
「/tmp/download_file/」というフォルダを作成し、それを管理対象にしたい、と言う想定です。
　
　

手順４．.gitignoreをサーバにアップしてコミットする

　
.gitignoreをサーバにアップしてコミットします。
この際、Gitにはキャッシュが設定されている場合があるため、キャッシュをクリアする必要があります。
　
　

Gitで空のフォルダを管理対象にする手順についての解説

　
「手順１」の「.gitkeep」というファイルは、Gitで管理する際の慣例のファイル名とも言える名称のため、多くの方が「.gitkeep」を使っています。
　
ですが、Gitの仕組み上はファイル名は何でも問題ありません。
　
CakePHPの場合は、空のフォルダには拡張子なしの「empty」という空のファイルが置いてありますので、CakePHPの場合は「empty」というファイル名に合わせる、ということも一つの方法と言えます。
　
　
「手順３」の .gitignoreの書き方については下記に記事を書いていますので、それを参考にしてください。
「tmp」や「vendor」フォルダなど、管理対象外にしているフォルダの中のファイルを管理対象にする場合は、正しく設定するには考慮する点があります。
.gitignoreで無視フォルダの中の特定のファイルを除外「!（否定文）」を使う場合の注意点
　
　
「手順４」の .gitignoreを変更した場合の設定の反映は、Gitが持っているキャッシュをクリアしないと正しく反映されない場合がよくあります。
キャッシュのクリア方法を下記の記事にしていますので参考にしてください。
.gitignoreを更新しても反映されないときは「git rm -r --cached .」でキャッシュを削除
　
　

Git関連の記事