1、為什么要有 .gitignore
文件?
項目中經常會生成一些Git系統不需要追蹤( track )的文件。典型的是在編譯生成過程中 產生的文件或是編程器生成的臨時備份文件。當然,你不追蹤( track )這些文件,可以 平時不用
git add
去把它們加到索引中。 但是這樣會很快變成一件煩人的事,你發現項目中到處有未追蹤( untracked )的文件; 這樣也使git add .
和git commit -a
變得實際上沒有用處,同時git status
命令的輸出也會有它們。你可以在你的頂層工作目錄中添加一個叫.gitignore
的文件,來告訴Git系統要忽略 掉哪些文件。
2、忽略文件原則:
- 忽略操作系統自動生成的文件,比如縮略圖、
.DS_Store
等; - 忽略編譯生成的中間文件、可執行文件等,也就是如果一個文件是通過另一個文件自動生成的,那自動生成的文件就沒必要放進版本庫,比如 Java 編譯產生的
.class
文件; - 忽略你自己的帶有敏感信息的配置文件,比如存放口令的配置文件;
- 或者是我們就是不想某個文件
push
上去,這個時候我們只需要在.gitignore
中寫入一些適當的規則, 就可以實現上面的效果。
3、 .gitignore
語法規范:
- 空行或是以#開頭的行即注釋行將被忽略;
- 以斜杠 “/” 結尾表示目錄;
- 以星號 “*” 通配多個字符;
- 以問號 “?” 通配單個字符;
- 以方括號 “[]” 包含單個字符的匹配列表;
- 以嘆號 “!” 表示不忽略(跟蹤)匹配到的文件或目錄;
- 可以在前面添加斜杠 “/” 來避免遞歸,下面的例子中可以很明白的看出來與下一條的區別。
4、示例:
# 忽略 .a 文件
*.a
# 但否定忽略 lib.a, 盡管已經在前面忽略了 .a 文件
!lib.a
# 僅在當前目錄下忽略 TODO 文件, 但不包括子目錄下的 subdir/TODO
/TODO
# 忽略 build/ 文件夾下的所有文件
build/
# 忽略 doc/notes.txt, 不包括 doc/server/arch.txt
doc/*.txt
# 忽略所有的 .pdf 文件 在 doc/ directory 下的
doc/**/*.pdf
5、 .gitignore
文件配置模板:
GitHub 上為開發者提供了各種環境以及各種編程語言的 gitignore 文件配置模板。
Objective-C.gitignore
Swift.gitignore
小結:
- 忽略某些文件時,需要編寫
.gitignore
。 -
.gitignore
文件本身要放到版本庫里,并且可以對.gitignore
做版本管理! - 從版本庫中刪除:
$ git rm test.txt
rm 'test.txt'
$ git commit -m "remove test.txt"