ソース管理にGitを使用しています。
基本的にはGitでバージョン管理をするわけですが、中には例外となるファイルも存在します。
今回はGitでソース管理をする上で、除外するファイルの管理方法についてまとめました。
Gitで管理すべきでないファイルとは？
- 自動作成されるファイル
- ログファイル
- パッケージファイル
- バックアップファイル
- ビルド後の成果物
- エディタ特有のファイル
- OSのファイル管理に使用されるファイル
- Thumbs.db(Windows)
- .DS_Store(macOS)
- 共有すべきでないファイル
- パスワードが記載されたファイル
自動作成されるファイルをあえてGitでバージョン管理する必要はありません。
また、パスワードが記載されているファイルに関しては、セキュリティの兼ね合いからGitで管理するかをきちんと検討する必要があります。
.gitignoreを使って管理しよう
Gitで管理すべきでないファイルは.gitignoreファイルを作成し、管理しましょう。
.gitignoreとは、簡単に説明すると「Gitが無視してくれるファイル/フォルダの定義」のことです。
.gitignoreファイルは作成したディレクトリ配下のパスにのみ有効です。
ファイルを作成する際はどのパスを有効にしたいかを考えてから作成しましょう。
.gitignoreの作成方法
作成方法は簡単で、エディタで.gitignoreファイルを作成します。
作成したファイルにGitで管理したくないファイル名やフォルダ名を入力します。
.vscode/
node_modules/
dist/
*.log
Thumbs.db
.DS_Store
使用する技術やIDEやエディタを指定してgitignoreを生成してくれるサイトもあります。
gitignore.ioで検索し、.gitignoreを作成する参考にしてみるのもいいでしょう。
まとめ
Gitで管理すべきでないファイルというものは、個人で使用している場合は自分の判断で問題ありません。
ただ、業務で使用しているソース管理をGitでする場合に関しては、自分の判断だけで決めてはならない場合もあります。
そういった場合は、きちんとルールを確認し、判断することが重要です。