Realmを使ったデータ保存をしようとしたらGithubの差分がとんでもない量になってしまった

はじめに

Realmを使ったデータ保存を実装し、Githubにデータをあげたところ以下のように差分がとんでもない量になってしました。通常は100以下のところ、今回は972,3871でした。

原因

Realm関係の差分も一緒にあがってしまったことによるものでした。

対策

git ignoreを使って必要のないファイルやフォルダをGitの差分監視対象から除外しました。

準備

1. プロジェクトファイルに.gitignoreファイルを作成。ターミナルで

   touch .gitignore
   

2. できても特に反応がないため、できたかどうかを確認するにはターミナルで

   ls -a
   

.gitignoreがあればOK

3.　ファインダーで確認する場合、.gitignoreファイルは隠しファイルなので、通常は表示されません

shift + command + . で見れるようになります（半透明）。

使う

1. ファインダー上の.gitignoreをクリックして開き、Pods/と.DS_Storeを書き、Pods/フォルダ配下の全てと.DS_StoreをGitの差分監視対象から除外。

2.　これでライブラリ関係は差分に出なくなりました。

これをしないままgithubにあげてしまうと、膨大なライブラリのファイルが入ってしまうので、リポジトリが圧迫されてしまい、パンクしてしまいます。

.gitignoreに記載しても正常に差分監視対象から除外されないケース

基本的には前述の.gitignoreファイルにファイルもしくはフォルダを記載するだけで差分監視対象からは除外されるようなのですが、過去にコミットしたことがあるファイルやフォルダの場合は.gitignoreファイルに記載しただけでは正常に除外されないようです。
これはGitの過去の記録の中に当該ファイルやフォルダの情報がキャッシュとして保存されてしまっているためです。
そのため、コレに該当する場合は下記のコマンドを使って対象ファイルやフォルダのキャッシュを削除するようにします。

$ git rm -r --cached ファイル名

上記のようにgit rm -r --cachedに続いてファイル名(フォルダ名)を指定することによって、対象ファイル(フォルダ)のキャッシュを削除することができます。
正常にGitの差分監視対象から除外されない場合は、このキャッシュが残っていないか確認することが必要です。