GitHubのリポジトリに空ディレクトリを配置する方法

GitHubのリポジトリに空のディレクトリは配置しておきたいことがあったので、その時に設定する内容のメモになります。

log出力先のディレクトリなど、必要になる機会は結構多いです。

対応前のファイル・ディレクトリの構成は以下の通りだとします。

test-app
├ log
│  ├ 20200119.log
│  └ 20200120.log
└ src
    └ entry.js

上記の構成の場合で、logディレクトリ配下の*.logファイルはバージョン管理する必要がありませんが、logディレクトリはGitHub上に配置しておきたいものになります。

空ディレクトリの設定方法は、まず、logディレクトリの下に「.gitkeep」という空ファイルを作成します。Windowsの場合は拡張子のみのファイルは作成できないので、「.gitkeep.」というようなファイル名にしてやると作成可能です。

続いて、test-appリポジトリの無視リスト「.gitignore」を以下のように設定します。

log/*
!.gitkeep

対応後のファイル・ディレクトリの構成は以下のようになります。

test-app
├ log
│  ├ 20200119.log
│  ├ 20200120.log
│  └ .gitkeep
├ src
│  └ entry.js
└ .gitignore

この状態でGitHubにプッシュすると、logディレクトリが空の状態（.gitkeepは存在する）で配置されます。