.gitignoreとは
要約すると.gitignore
とは、APIKeyなどの他者に知られることで問題が発生する恐れのあるコードをgit(Github)にアップしないファイルを設定するものです。
セキュリティの一環として扱われています。
.gitignoreファイルの作成方法
ターミナルで対象プロジェクトのディレクトリに移動して以下コマンドでファイル作成
% touch .gitignore
作成したファイルを以下コマンドで開く
% open .gitignore
開いたファイルに以下コードを記述
# Xcode
build/
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
xcuserdata
*.xccheckout
*.moved-aside
DerivedData
*.hmap
*.ipa
*.xcuserstate
# CocoaPod
Pods/*
# others
*.swp
!.gitkeep
.DS_Store
また、開発の途中で(すでにgitにコミットしていた場合).gitignore
を作成する場合は、
以下コマンドで一度全てのファイルをgitの対象外に設定
git rm -r --cached .
次に、改めてgitの対象に設定
git add .
この二つのコマンドを実行することで開発途中からでも.gitignore
に登録したファイルはアップされなくなる。
もっとも、プロジェクト作成直後に.gitignore
ファイルを作成しておくにこしたことはない。
備考
Macのデフォルト設定として.(ドット)
から始まるファイルは閲覧できなくなっていおるので、.gitignore
ファイルを作成してもFinderなどでは表示されない。(なのでターミナルから開く)
Finder等できっちり確認したい方はMac の Finder で隠しファイルの表示/非表示を切り替える方法を参考にしてください。