gitignoreの書き方とファイルの除外方法

2019年5月13日

.gitignoreとは?

.gitignoreとはgitで管理したくないファイルを無視させるためのファイルです。

本稿では、.gitignoreの書き方をみていきましょう。

 

 

.gitignoreの設定方法

  • 無視する設定を行いたいフォルダに .gitignore という名前でファイルを作成する
  • 設定の有効範囲は .gitignore ファイルの有るフォルダ内全て
  • 無視したいファイルを次項の書き方をもとに .gitignore 内で指定する

 

.gitignoreの書き方

指定できる書式は下記になります。

 

特定のファイルを除外する

# ディレクトリを問わずhogehoge.htmlを除外
hogehoge.html
# .gitignoreが設置されているディレクトリ内のhogehgoe.htmlを除外
/hogehoge.html

 

ハッシュ記号で始まる行はコメントとして扱われる

# "#"で始まる行はコメント

 

空行は無視される

# 下に空行がありますがこれは無視されます。

 

! マークで始まる行は残りのパターンを否定

# 下記で.gitignoreが設置されているディレクトリにて、
# bin以外のフォルダ、ファイルは全て除外対象になる
! bin/

 

スラッシュ/で終わる場合はディレクトリを表す

# 下記でbinフォルダ配下全てを除外対象にする
bin/

 

スラッシュ/で始まる場合はルートディレクトリからを表す

# スラッシュ/で始まる場合はルートディレクトリからを表す
/hogehoge/bin/

 

*は任意文字列を表す

# 全てのapkファイルを指定する場合
*.apk
# bin配下のapkファイルを指定する場合
/bin/*.apk

 

.gitignoreのサンプル

私が使用している.gitignoreは下記です。

開発環境によってgitで管理するファイルは異なってきますので、 個人でアレンジして下さい。

# クラスファイル
*.class
# ビルドファイル
*.apk
*.ap_
# files for the dex VM
*.dex
# binとgen配下はコミット対象外
bin/
gen/
# ローカルファイル
local.properties
# Mac不要ファイル
.DS_Store
# Windows不要ファイル
Thumbs.db