.gitignoreの表記ルールと例

.gitignoreの書き方について簡単に記載します。

.gitignoreの概要

.gitignoreとは、git上にアップしたくないファイルを指定するためのファイルです。

• 容量が大きすぎるファイル
• 毎ビルド差分が出てしまうファイル
• ビルドすれば勝手に生成されるのでgitにアップする必要がないファイル

などは.gitignoreに記載し、gitにアップしないようにすることが推奨されています。

$ git init で自動的に作成されるわけではなく、開発者自身で作る必要があります。
ファイル名を正しく .gitignore とすればちゃんと反映されます。

ファイル作成方法の例

$ touch .gitignore # ファイル自体の作成。
$ vi .gitignore # ファイルを編集。

.gitignoreについて知っておくと便利そうなこと

• リポジトリのルート階層ににある必要はない。
• .gitignoreファイルはリポジトリに複数あってよい。
• 有効範囲は.gitignoreがある階層以下全部。（親階層のファイルには無効）

.gitignoreの表記方法

# コメント	           # `#`で始まる行はコメント。
*.exe	            # 特定の拡張子（今回は.exe）を含むファイルを指定する。
bin/	            # 特定のフォルダ（今回はbin）の中身すべてを指定する。
!needfile.txt	    # 特定のファイルを指定しない。ignoreしない。
package/**/*.txt    # フォルダ内の特定拡張（今回はpackageフォルダ内の.txt拡張子）子を指定する。

.gitignoreの例

自身のiOSプロジェクトで用いてるものの一部を抜粋。

# generally
.DS_Store
*.swp
DerivedData

# ObjC/Swift specific
*.hmap
*.ipa

# Carthage
Carthage/

# Other
*.xccheckout
*.moved-aside
*.xcuserstate
*.xcsmblueprint

補足

.gitignoreに書いたのに反映されない！というときはこちらを参照。
https://qiita.com/fuwamaki/items/3ed021163e50beab7154

参考

https://qiita.com/inabe49/items/16ee3d9d1ce68daa9fff
https://qiita.com/anqooqie/items/110957797b3d5280c44f