對于經(jīng)常使用Git的朋友來說,.gitignore配置一定不會(huì)陌生脏榆。廢話不說多了缘厢,接下來就來說說這個(gè).gitignore的使用。
首先要強(qiáng)調(diào)一點(diǎn)沛励,這個(gè)文件的完整文件名就是".gitignore"责语,注意最前面有個(gè)“.”。
一般來說每個(gè)Git項(xiàng)目中都需要一個(gè)“.gitignore”文件侯勉,這個(gè)文件的作用就是告訴Git哪些文件不需要添加到版本管理中鹦筹。實(shí)際項(xiàng)目中,很多文件都是不需要版本管理的址貌,比如Python的.pyc文件和一些包含密碼的配置文件等等铐拐。這個(gè)文件的內(nèi)容是一些規(guī)則徘键,Git會(huì)根據(jù)這些規(guī)則來判斷是否將文件添加到版本控制中。
下面我們看看常用的規(guī)則:
1)/mtk/? ? ? ? ? ? ? 過濾整個(gè)文件夾
2)*.zip? ? ? ? ? ? ? ? 過濾所有.zip文件
3)/mtk/do.c? ? ? ? 過濾某個(gè)具體文件
很簡單吧遍蟋,被過濾掉的文件就不會(huì)出現(xiàn)在git倉庫中(gitlab或github)了吹害,當(dāng)然本地庫中還有,只是push的時(shí)候不會(huì)上傳虚青。
需要注意的是它呀,gitignore還可以指定要將哪些文件添加到版本管理中:
1)!*.zip
2)!/mtk/one.txt
唯一的區(qū)別就是規(guī)則開頭多了一個(gè)感嘆號,Git會(huì)將滿足這類規(guī)則的文件添加到版本管理中棒厘。
為什么要有兩種規(guī)則呢纵穿?想象一個(gè)場景:假如我們只需要管理/mtk/目錄中的one.txt文件,這個(gè)目錄中的其他文件都不需要管理奢人,那么我們就需要使用:
1)/mtk/
2)!/mtk/one.txt
假設(shè)我們只有過濾規(guī)則谓媒,而沒有添加規(guī)則,那么我們就需要把/mtk/目錄下除了one.txt以外的所有文件都寫出來何乎!
最后需要強(qiáng)調(diào)的一點(diǎn)是句惯,如果你不慎在創(chuàng)建.gitignore文件之前就push了項(xiàng)目,那么即使你在.gitignore文件中寫入新的過濾規(guī)則支救,這些規(guī)則也不會(huì)起作用抢野,Git仍然會(huì)對所有文件進(jìn)行版本管理。
簡單來說各墨,出現(xiàn)這種問題的原因就是Git已經(jīng)開始管理這些文件了指孤,所以你無法再通過過濾規(guī)則過濾它們。因此一定要養(yǎng)成在項(xiàng)目開始就創(chuàng)建.gitignore文件的習(xí)慣贬堵,否則一旦push邓厕,處理起來會(huì)非常麻煩。
.gitignore配置文件用于配置不需要加入版本管理的文件扁瓢,配置好該文件可以為版本管理帶來很大的便利,以下是對于配置.gitignore的一些心得記錄:
1)配置語法:
以斜杠“/”開頭表示目錄补君;
以星號“*”通配多個(gè)字符引几;
以問號“?”通配單個(gè)字符
以方括號“[]”包含單個(gè)字符的匹配列表;
以嘆號“!”表示不忽略(跟蹤)匹配到的文件或目錄挽铁;
此外伟桅,git 對于 .ignore 配置文件是按行從上到下進(jìn)行規(guī)則匹配的,意味著如果前面的規(guī)則匹配的范圍更大叽掘,則后面的規(guī)則將不會(huì)生效楣铁;
2)示例說明
a)規(guī)則:fd1/*
說明:忽略目錄 fd1 下的全部內(nèi)容;注意更扁,不管是根目錄下的 /fd1/ 目錄盖腕,還是某個(gè)子目錄 /child/fd1/ 目錄赫冬,都會(huì)被忽略;
b)規(guī)則:/fd1/*
說明:忽略根目錄下的 /fd1/ 目錄的全部內(nèi)容溃列;
c)規(guī)則:
/*
!.gitignore
!/fw/bin/
!/fw/sf/
說明:忽略全部內(nèi)容劲厌,但是不忽略 .gitignore 文件、根目錄下的 /fw/bin/ 和 /fw/sf/ 目錄听隐;
-------------------------------------------------------------------------------------------------------------------
下面是線上使用過的一個(gè)gerrit里項(xiàng)目代碼的.gitignore的配置(在項(xiàng)目中添加.gitignore過濾文件补鼻,在git push到gerrit里即可)
# Byte-compiled / optimized / DLL files
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
#? Usually these files are written by a python script from a template
#? before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
# Translations
*.mo
*.pot
# Django stuff:
*.log
.static_storage/
.media/
local_settings.py
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
#
__pycache__/
example/__pycache__/
example/data/*.csv
example/data/train/*.csv
example/data/exp_data/*.csv
example/data/test/*.csv
example/output/*.csv
example/data/log/*.log
yellowfin.py
其實(shí),需要清除的一點(diǎn)是:
有三種方法可以實(shí)現(xiàn)過濾掉Git里不想上傳的文件雅任,這三種方法都能達(dá)到目的风范,只不過適用情景不一樣。
1)第一種方法
針對單一工程排除文件沪么,這種方式會(huì)讓這個(gè)工程的所有修改者在克隆代碼的同時(shí)硼婿,也能克隆到過濾規(guī)則,而不用自己再寫一份成玫,這就能保證所有修改者應(yīng)用的都是同一份規(guī)則加酵,而不是張三自己有一套過濾規(guī)則,李四又使用另一套過濾規(guī)則哭当,個(gè)人比較喜歡這個(gè)猪腕。配置步驟如下:
在工程根目錄下建立.gitignore文件,將要排除的文件或目錄 寫到.gitignore這個(gè)文件中钦勘,其中有兩種寫入方法陋葡。
a)使用命令行增加排除文件
排除以.class結(jié)尾的文件 echo “*.class” >.gitignore (>> 是在文件尾增加,> 是刪除已經(jīng)存在的內(nèi)容再增加),之后會(huì)在當(dāng)前目錄下生成一個(gè).gitignore的文件彻采。
排除bin目錄下的文件 echo “bin/” >.gitignore
b)最方便的辦法是腐缤,用記事本打開,增加需要排除的文件或目錄肛响,一行增加一個(gè)岭粤,例如:
*.class
*.apk
bin/
gen/
.settings/
proguard/
2)第二種方法
全局設(shè)置排除文件,這會(huì)在全局起作用特笋,只要是Git管理的工程剃浇,在提交時(shí)都會(huì)自動(dòng)排除不在控制范圍內(nèi)的文件或目錄。這種方法對開發(fā)者來說猎物,比較省事虎囚,只要一次全局配置,不用每次建立工程都要配置一遍過濾規(guī)則蔫磨。但是這不保證其他的開發(fā)者在克隆你的代碼后淘讥,他們那邊的規(guī)則跟你的是一樣的,這就帶來了代碼提交過程中的各種沖突問題堤如。
配置步驟如下:
a)像方法(1)一樣蒲列,也需要建立一個(gè).gitignore文件窒朋,把要排除的文件寫進(jìn)去。
b)但在這里嫉嘀,我們不規(guī)定一定要把.gitnore文件放到某個(gè)工程下面炼邀,而是任何地方,比如我們這里放到了Git默認(rèn)的Home路徑下剪侮,比如:/home/wangshibo/hqsb_ios
c)使用命令方式可以配置全局排除文件 git config --global core.excludesfile ~/.gitignore拭宁,你會(huì)發(fā)現(xiàn)在~/.gitconfig文件中會(huì)出現(xiàn)excludesfile = /home/wangshibo/hqsb_ios/.gitignore。
說明Git把文件過濾規(guī)則應(yīng)用到了Global的規(guī)則中瓣俯。
3)第三種方法
單個(gè)工程設(shè)置排除文件杰标,在工程目錄下找到.git/info/exclude,把要排除的文件寫進(jìn)去:
*.class
*.apk
bin/
gen/
.settings/
proguard/
這種方法就不提倡了彩匕,只能針對單一工程配置腔剂,而且還不能將過濾規(guī)則同步到其他開發(fā)者,跟方法(1)(2)比較起來沒有一點(diǎn)優(yōu)勢驼仪。
------------------------Git忽略規(guī)則及.gitignore規(guī)則不生效的解決辦法-----------------------------
在git中如果想忽略掉某個(gè)文件掸犬,不讓這個(gè)文件提交到版本庫中,可以使用修改根目錄中 .gitignore 文件的方法(如無绪爸,則需自己手工建立此文件)湾碎。這個(gè)文件每一行保存了一個(gè)匹配的規(guī)則例如:
# 此為注釋 – 將被 Git 忽略
*.a # 忽略所有 .a 結(jié)尾的文件
!lib.a # 但 lib.a 除外
/TODO # 僅僅忽略項(xiàng)目根目錄下的 TODO 文件,不包括 subdir/TODO
build/ # 忽略 build/ 目錄下的所有文件
doc/*.txt # 會(huì)忽略 doc/notes.txt 但不包括 doc/server/arch.txt
規(guī)則很簡單奠货,不做過多解釋介褥,但是有時(shí)候在項(xiàng)目開發(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 就對它們完全無效裕便。
原文參考:https://www.cnblogs.com/kevingrace/p/5690241.html