git的 .gitignore 配置概述

學習背景：自己在使用git時發現有時會上傳很多無用的配置檔案，或者在專案中已經包含一個本地的git倉庫，導致上一級專案上傳總是報錯，所以學習採用gitignore配置忽略包含的子專案。

使用場景

.gitignore 配置檔案用於配置不需要加入版本管理的檔案，配置好該檔案可以為我們的版本管理帶來很大的便利。比如專案的本地配置資訊，如果你上傳到Git中去其他人pull下來的時候就會和他本地的配置有衝突，所以這樣的個性化配置檔案我們一般不把它推送到git伺服器中。

忽略檔案的原則

• 忽略作業系統自動生成的檔案，比如縮圖等；
• 忽略編譯生成的中間檔案、可執行檔案等，也就是如果一個檔案是通過另一個檔案自動生成的，那自動生成的檔案就沒必要放進版本庫，比如Java編譯產生的.class檔案；
• 忽略你自己的帶有敏感資訊的配置檔案，比如存放口令的配置檔案。
• 忽略一些沒有必要上傳的大檔案、圖片等

Git忽略規則

詳細的忽略規則可以參考官方英文文件

可以組合官方配置文件使用

1、Git 忽略規則優先順序

在 .gitingore 檔案中，每一行指定一個忽略規則，Git 檢查忽略規則的時候有多個來源，它的優先順序如下（由高到低）：

• 從命令列中讀取可用的忽略規則
• 當前目錄定義的規則
• 父級目錄定義的規則，依次遞推
• $GIT_DIR/info/exclude 檔案中定義的規則
• core.excludesfile中定義的全域性規則

2、Git 忽略規則匹配語法

在 .gitignore 檔案中，每一行的忽略規則的語法如下：

• 空格不匹配任意檔案，可作為分隔符，可用反斜槓轉義
• # 開頭的檔案標識註釋，可以使用反斜槓進行轉義
• ! 開頭的模式標識否定，該檔案將會再次被包含，如果排除了該檔案的父級目錄，則使用 ! 也不會再次被包含。可以使用反斜槓進行轉義
• / 結束的模式只匹配資料夾以及在該資料夾路徑下的內容，但是不匹配該檔案
• / 開始的模式匹配專案跟目錄
• 如果一個模式不包含斜槓，則它匹配相對於當前 .gitignore 檔案路徑的內容，如果該模式不在 .gitignore 檔案中，則相對於專案根目錄
• ** 匹配多級目錄，可在開始，中間，結束
• ? 通用匹配單個字元
• [] 通用匹配單個字元列表

3、常用匹配示例：

• bin/: 忽略當前路徑下的bin資料夾，該資料夾下的所有內容都會被忽略，不忽略 bin 檔案
• /bin: 忽略根目錄下的bin檔案
• /*.c: 忽略 cat.c，不忽略 build/cat.c
• debug/*.obj: 忽略 debug/io.obj，不忽略 debug/common/io.obj 和 tools/debug/io.obj
• **/foo: 忽略/foo, a/foo, a/b/foo等
• a/**/b: 忽略a/b, a/x/b, a/x/y/b等
• !/bin/run.sh: 不忽略 bin 目錄下的 run.sh 檔案
• *.log: 忽略所有 .log 檔案
• config.php: 忽略當前路徑的 config.php 檔案

3、定義Git全域性的 .gitignore 檔案

除了可以在專案中定義 .gitignore 檔案外，還可以設定全域性的 git .gitignore 檔案來管理所有Git專案的行為。這種方式在不同的專案開發者之間是不共享的，是屬於專案之上Git應用級別的行為。

這種方式也需要建立相應的 .gitignore 檔案，可以放在任意位置。然後在使用以下命令配置Git：

git config --global core.excludesfile ~/.gitignore

4、檢視gitignore規則

如果你發下.gitignore寫得有問題，需要找出來到底哪個規則寫錯了，可以用git check-ignore命令檢查：

$ git check-ignore -v HelloWorld.cpp
.gitignore:1:*.cpp    HelloWorld.cpp

注意

.gitignore只能忽略那些原來沒有被track的檔案，如果某些檔案已經被納入了版本管理中，則修改.gitignore是無效的。解決方法就是先把本地快取刪除，然後再提交。