本文主要記錄了在使用Git過程中遇到的一個問題,也就是標題所說的在.gitignore文件里添加的忽略規(guī)則沒有生效,導致本應該被忽略的文件/文件夾和目錄總是不斷的被Git納入版本管理,每當項目文件修改都會重復引發(fā)跟蹤!
首先要說明下,本文所提及的問題,Git官方是有很詳細的文檔進行說明的,包括具體的情景和解決辦法,所以后面會引用Git官方中文文檔的說明,本文算是一篇記錄筆記,會結合我自己的理解和案例來寫,這里建議先看Git文檔的這一章節(jié):2.2 Git 基礎 - 記錄每次更新到倉庫,重點在文檔底部的移除文件節(jié)點,如果對Git比較不熟悉的朋友,強烈建議讀完整個章節(jié)。
一、.gitignore規(guī)則無效的原因
據(jù)我所知導致.gitignore里的忽略規(guī)則失效只有兩種情況,當然我對Git的使用和理解比較淺薄,也只能想到這兩個方面:一種是忽略規(guī)則的語法錯誤,這種情形好處理,只要修正錯誤的語法就可以了。PS:本文不對語法錯誤的問題詳細說明,畢竟每個人情況不同。排查語法問題這事我也不知道怎么舉例,總之只要符合官方規(guī)范的就可以了,需要注意的好像也就一個路徑問題吧?!
另一種則是本文要重點說明的情況:項目中的文件或目錄已經(jīng)被納入到Git的版本管理里面/跟蹤文件清單,此時你再往.gitignore里添加此文件/目錄的忽略規(guī)則就會發(fā)現(xiàn)毫無作用,因為已經(jīng)被Git跟蹤(track)的文件/目錄無法被.gitignore忽略掉!。
這里再對上面一段所說的進行詳細說明,所謂“已經(jīng)被納入到Git的版本管理里面/跟蹤文件清單”,大體上指的是下面的三種情況:
- 已使用
add命令開始跟蹤項目文件或者將修改的文件放入暫存區(qū)/索引 - 已使用
commit命令提交更新到本地倉庫 - 已使用
push命令將項目文件推送到了Git遠程倉庫了(例如GitHub)
上述的三種操作只要進行了其中一項,再添加對應文件的忽略規(guī)則都是不生效的!PS:這三個命令在GUI客戶端上一般都可以找到對應的按鈕和操作。
這里額外提下,如果按照反向理解,也就是說只要是文件/目錄還沒有被Git跟蹤,那么你添加的忽略規(guī)則都是有效的,重點在于文件的是否屬于被跟蹤(track)狀態(tài)。
二、具體的解決方法-配合案例演示
先說使用Git命令處理的方法,這也是我比較推薦的方式,后面還會講一個簡單的方法但并不推薦,因為不利于Git的學習與掌握,而且有部分限制。這里額外再提醒下,官方文檔是有詳細的解決方法的,建議閱讀官方文檔,接下來會結合一個案例來進行說明。
2.1 案例背景說明
這里我在VS里新建了一個ASP.NET MVC項目并進行生成,項目生成后會創(chuàng)建bin文件夾(注意這時候還未添加對應的忽略規(guī)則,bin文件夾里都是編譯生成的文件):

此時由于疏忽大意或操作失誤不小心使用add命令對bin文件夾以及里面所有文件進行了跟蹤(例如使用git add -A,或者直接用GUI客戶端批量操作),發(fā)現(xiàn)后想要亡羊補牢在.gitignore里添加了[Bb]in/這條規(guī)則([Bb]in/=Bin/+bin/,也就是大小寫都能匹配到),但是發(fā)現(xiàn)并沒什么用,在命令行窗口使用git status可以看到bin文件夾里的文件無法被忽略:

GUI界面截圖:

2.2 未進行提交操作的處理方式
如果此時還未進行提交操作,趕緊使用如下命令可及時挽救:git rm --cached <file>,其中<file>表示要從暫存區(qū)移除出去的文件名或者目錄路徑,注意可以使用通配符。不過Git有自己的通配符規(guī)則,所以要注意下差異,例如官方文檔有提到在*號前面是需要加反斜杠\的(我有測試過不加也沒事但是最好按照規(guī)范來),結合上面的案例,因為我們要移除bin文件夾下的所有文件,所以完整的Git命令為(注意路徑一定要正確):
git rm --cached WebApplication1/WebApplication1/bin/\*


這里要留意忽略規(guī)則的添加時機,在命令執(zhí)行后會有不同的影響,假設忽略規(guī)則是在git rm --cached <file>命令執(zhí)行前就設置了,那么當命令執(zhí)行完成后馬上就可以看到效果,bin文件夾及里面的所有文件會被Git直接忽略。如果在命令執(zhí)行后還沒有添加忽略規(guī)則,你會發(fā)現(xiàn)bin文件夾下的文件變成未被跟蹤的狀態(tài),也就是最初的狀態(tài),此時你再添加忽略規(guī)則這些文件就會被忽略了。
2.3 文件已經(jīng)進行提交操作的處理方式
如果bin文件夾已經(jīng)被Git跟蹤并提交到了本地版本庫甚至遠程版本庫(例如GitHub),解決方法和上一小節(jié)2.2中的方法是一樣的,依然是使用git rm --cached <file> 這個命令。PS:在執(zhí)行此命令前Git最好能保持干凈的狀態(tài),也就是"nothing to commit, working tree clean"。
注意?。?!在命令執(zhí)行后受影響的文件都會變成未跟蹤狀態(tài),此時一定要馬上使用git commit -m '備注信息'命令提交這部分修改,如果還未設置.gitignore文件則可以設置后一并提交此次更新到本地倉庫。這里千萬不要使用任何GUI客戶端去操作!因為不同GUI客戶端可能有不一樣的執(zhí)行結果(例如可能會將文件重新納入跟蹤,等于剛剛的操作白費了)。

2.4 簡單的解決方法:直接刪除物理文件
在上面兩小節(jié)2.2-2.3中使用git rm --cached <file>命令最終只是將文件從暫存區(qū)移除而不刪除物理文件(也就是只刪除Git對文件或目錄的跟蹤狀態(tài)),這樣的好處是一些項目開發(fā)或調試需要的文件都可以保留下來,例如本地日志文件、編譯文件、本地數(shù)據(jù)庫、測試圖片之類的。
如果遇到實在依賴GUI客戶端或者對Git命令不熟悉,也沒有時間去查閱官方文檔的情況,也只能通過簡單的方法去處理了,大體操作流程如下:
- 先將文件進行備份,除非能確定文件刪除后不需要還原回來,否則一定要做好備份
- 備份完成后直接從硬盤/本地工作目錄里刪除這些無法被忽略掉的文件或文件夾
- 然后馬上提交這部分修改到Git版本庫里(通過GUI客戶端進行操作或者使用Git命令都可以)
- 接著在
.gitignore文件中添加忽略規(guī)則并提交到Git版本庫里 - 最后將之前刪除的文件拷貝回來(注意第一步已經(jīng)做了備份)
完成上面5個步驟可以測試下忽略規(guī)則是否有重新生效。
最后附上官方文檔的截圖:
三、總結
先來一段碎碎念,作為一名輕度的Git使用者,總是為了圖方便而使用類似GitHub DeskTop的GUI客戶端。偷懶的結果就是對Git的掌握處于半桶水的水平,只知道怎么用而沒有深入理解和搞懂,也就是所謂的“只知其然,而不知其所以然”。最近遇到了這個小問題徹底暴露了隱藏的缺陷,只好靜下心來好好讀一遍官方文檔,從頭理解Git并學習命令行的使用方式。
最后總結下兩點:
- 良好的開發(fā)習慣還是要有的,在項目添加到Git版本控制庫之前,一定要先設置好忽略規(guī)則。
- 已經(jīng)被Git跟蹤(track)的文件是不受
.gitignore影響的。
轉載:由十有三創(chuàng)作**
來源 https://shiyousan.com/post/636470505667009340
