Cover By:https://www.cnblogs.com/kevingrace/p/5690241.html
對于經(jīng)常使用Git的朋友來說,.gitignore配置一定不會陌生蝶念。廢話不說多了,接下來就來說說這個.gitignore的使用媒殉。
首先要強調(diào)一點,這個文件的完整文件名就是".gitignore"全封,注意最前面有個“.”刹悴。
一般來說每個Git項目中都需要一個“.gitignore”文件攒暇,這個文件的作用就是告訴Git哪些文件不需要添加到版本管理中。實際項目中恒削,很多文件都是不需要版本管理的尾序,比如Python的.pyc文件和一些包含密碼的配置文件等等。這個文件的內(nèi)容是一些規(guī)則携丁,Git會根據(jù)這些規(guī)則來判斷是否將文件添加到版本控制中兰怠。
下面我們看看常用的規(guī)則:
1)/mtk/ 過濾整個文件夾
2)*.zip 過濾所有.zip文件
3)/mtk/do.c 過濾某個具體文件
很簡單吧揭保,被過濾掉的文件就不會出現(xiàn)在git倉庫中(gitlab或github)了,當然本地庫中還有存筏,只是push的時候不會上傳味榛。
需要注意的是,gitignore還可以指定要將哪些文件添加到版本管理中:
1)!*.zip
2)!/mtk/one.txt
唯一的區(qū)別就是規(guī)則開頭多了一個感嘆號善茎,Git會將滿足這類規(guī)則的文件添加到版本管理中频轿。
為什么要有兩種規(guī)則呢烁焙?想象一個場景:假如我們只需要管理/mtk/目錄中的one.txt文件考阱,這個目錄中的其他文件都不需要管理鞠苟,那么我們就需要使用:
1)/mtk/
2)!/mtk/one.txt
假設我們只有過濾規(guī)則秽之,而沒有添加規(guī)則,那么我們就需要把/mtk/目錄下除了one.txt以外的所有文件都寫出來跨细!
最后需要強調(diào)的一點是河质,如果你不慎在創(chuàng)建.gitignore文件之前就push了項目,那么即使你在.gitignore文件中寫入新的過濾規(guī)則散休,這些規(guī)則也不會起作用乐尊,Git仍然會對所有文件進行版本管理扔嵌。
簡單來說,出現(xiàn)這種問題的原因就是Git已經(jīng)開始管理這些文件了胁勺,所以你無法再通過過濾規(guī)則過濾它們独旷。因此一定要養(yǎng)成在項目開始就創(chuàng)建.gitignore文件的習慣,否則一旦push蛇捌,處理起來會非常麻煩咱台。
.gitignore配置文件用于配置不需要加入版本管理的文件,配置好該文件可以為版本管理帶來很大的便利春贸,以下是對于配置.gitignore的一些心得記錄:
1)配置語法:
以斜杠“/”開頭表示目錄;
以星號“*”通配多個字符逸嘀;
以問號“?”通配單個字符
以方括號“[]”包含單個字符的匹配列表允粤;
以嘆號“!”表示不忽略(跟蹤)匹配到的文件或目錄;
此外司光,git 對于 .ignore 配置文件是按行從上到下進行規(guī)則匹配的悉患,意味著如果前面的規(guī)則匹配的范圍更大,則后面的規(guī)則將不會生效坞淮;
2)示例說明
a)規(guī)則:fd1/*
說明:忽略目錄 fd1 下的全部內(nèi)容回窘;注意市袖,不管是根目錄下的 /fd1/ 目錄,還是某個子目錄 /child/fd1/ 目錄付枫,都會被忽略驰怎;
b)規(guī)則:/fd1/*
說明:忽略根目錄下的 /fd1/ 目錄的全部內(nèi)容;
c)規(guī)則:
/*
!.gitignore
!/fw/bin/
!/fw/sf/
說明:忽略全部內(nèi)容掂榔,但是不忽略 .gitignore 文件症杏、根目錄下的 /fw/bin/ 和 /fw/sf/ 目錄厉颤;
下面是線上使用過的一個gerrit里項目代碼的.gitignore的配置(在項目中添加.gitignore過濾文件,在git push到gerrit里即可)
···Android工程
#Built application files
*.apk
*.ap_
# Files for the Dalvik VM
*.dex
# Java class files
*.class
# Generated files
*/bin/
*/gen/
*/out/
# Gradle files
.gradle/
build/
*/build/
gradlew
gradlew.bat
# Local configuration file (sdk path, etc)
local.properties
# Proguard folder generated by Eclipse
proguard/
# Log Files
*.log
# Android Studio Navigation editor temp files
.navigation/
# Android Studio captures folder
captures/
# Intellij
*.iml
*/*.iml
# Keystore files
#*.jks
#gradle wrapper
gradle/
#some local files
*/.settings/
*/.DS_Store
.DS_Store
*/.idea/
.idea/
gradlew
gradlew.bat
unused.txt
再看一例
···Ios工程
# Lines that start with '#' are comments.
# IntelliJ IDEA Project files
.idea
*.iml
*.ipr
*.iws
out
# Eclipse Project files
.classpath
.project
.settings/
bin/
gen/
local.properties
.DS_Store
Thumbs.db
*.bak
*.tem
*.temp
#.swp
*.*~
~*.*
其實秤涩,需要清除的一點是:
有三種方法可以實現(xiàn)過濾掉Git里不想上傳的文件司抱,這三種方法都能達到目的,只不過適用情景不一樣匀谣。
1)第一種方法
針對單一工程排除文件资溃,這種方式會讓這個工程的所有修改者在克隆代碼的同時,也能克隆到過濾規(guī)則,而不用自己再寫一份梳庆,這就能保證所有修改者應用的都是同一份規(guī)則膏执,而不是張三自己有一套過濾規(guī)則,李四又使用另一套過濾規(guī)則欺栗,個人比較喜歡這個征峦。配置步驟如下:
在工程根目錄下建立.gitignore文件,將要排除的文件或目錄 寫到.gitignore這個文件中类腮,其中有兩種寫入方法蛉加。
a)使用命令行增加排除文件
排除以.class結(jié)尾的文件 echo “*.class” >.gitignore (>> 是在文件尾增加,> 是刪除已經(jīng)存在的內(nèi)容再增加),之后會在當前目錄下生成一個.gitignore的文件厂抽。
排除bin目錄下的文件 echo “bin/” >.gitignore
b)最方便的辦法是丁眼,用記事本打開,增加需要排除的文件或目錄嵌施,一行增加一個,例如:
*.class
*.apk
bin/
gen/
.settings/
proguard/
2)第二種方法
全局設置排除文件吃靠,這會在全局起作用足淆,只要是Git管理的工程,在提交時都會自動排除不在控制范圍內(nèi)的文件或目錄族奢。這種方法對開發(fā)者來說丹鸿,比較省事,只要一次全局配置廊敌,不用每次建立工程都要配置一遍過濾規(guī)則门怪。但是這不保證其他的開發(fā)者在克隆你的代碼后,他們那邊的規(guī)則跟你的是一樣的肋殴,這就帶來了代碼提交過程中的各種沖突問題坦弟。
配置步驟如下:
a)像方法(1)一樣,也需要建立一個.gitignore文件蔽豺,把要排除的文件寫進去。
b)但在這里修陡,我們不規(guī)定一定要把.gitnore文件放到某個工程下面可霎,而是任何地方,比如我們這里放到了Git默認的Home路徑下拾因,比如:/home/wangshibo/hqsb_ios
c)使用命令方式可以配置全局排除文件 git config --global core.excludesfile /.gitignore,你會發(fā)現(xiàn)在/.gitconfig文件中會出現(xiàn)excludesfile = /home/wangshibo/hqsb_ios/.gitignore扁达。
說明Git把文件過濾規(guī)則應用到了Global的規(guī)則中跪解。
3)第三種方法
單個工程設置排除文件签孔,在工程目錄下找到.git/info/exclude,把要排除的文件寫進去:
*.class
*.apk
bin/
gen/
.settings/
proguard/
這種方法就不提倡了图仓,只能針對單一工程配置但绕,而且還不能將過濾規(guī)則同步到其他開發(fā)者,跟方法(1)(2)比較起來沒有一點優(yōu)勢六孵。
------------------------Git忽略規(guī)則及.gitignore規(guī)則不生效的解決辦法-----------------------------
在git中如果想忽略掉某個文件草丧,不讓這個文件提交到版本庫中莹桅,可以使用修改根目錄中 .gitignore 文件的方法(如無,則需自己手工建立此文件)懂拾。這個文件每一行保存了一個匹配的規(guī)則例如:
.... 此為注釋 – 將被 Git 忽略
.a # 忽略所有 .a 結(jié)尾的文件
!lib.a # 但 lib.a 除外
/TODO # 僅僅忽略項目根目錄下的 TODO 文件岖赋,不包括 subdir/TODO
build/ # 忽略 build/ 目錄下的所有文件
doc/.txt # 會忽略 doc/notes.txt 但不包括 doc/server/arch.txt
規(guī)則很簡單,不做過多解釋唐断,但是有時候在項目開發(fā)過程中杭抠,突然心血來潮想把某些目錄或文件加入忽略規(guī)則,按照上述方法定義后發(fā)現(xiàn)并未生效丹诀,原因是.gitignore只能忽略那些原來沒有被track的文件,如果某些文件已經(jīng)被納入了版本管理中,則修改.gitignore是無效的枚荣。那么解決方法就是先把本地緩存刪除(改變成未track狀態(tài)),然后再提交:
git rm -r --cached .
git add .
git commit -m 'update .gitignore'
注意:
不要誤解了 .gitignore 文件的用途呼畸,該文件只能作用于 Untracked Files卧须,也就是那些從來沒有被 Git 記錄過的文件(自添加以后,從未 add 及 commit 過的文件)椭员。
如果文件曾經(jīng)被 Git 記錄過,那么.gitignore 就對它們完全無效埋同。