正常情况下,我们都是通过.gitignore文件中配置需要忽略的文件,默认情况下会有.gitignore文件,如果没有可以在某个文件夹下自定义.gitignore文件,在该文件中定义相应的忽略规则,来管理当前文件夹下的文件的Git提交行为。.gitignore 文件是可以提交到公有仓库中,这就为该项目下的所有开发者都共享一套定义好的忽略规则。在.gitingore 文件中,遵循相应的语法,在每一行指定一个忽略规则。如:
*.log *.temp /vendor
一、.gitignore忽略规则的匹配语法
在 .gitignore 文件中,每一行的忽略规则的语法如下:需要谨记:git对于.ignore配置文件是按行从上到下进行规则匹配的,意味着如果前面的规则匹配的范围更大,则后面的规则将不会生效;
- 空格不匹配任意文件,可作为分隔符,可用反斜杠转义
-
以“#”开头的行都会被 Git 忽略。即#开头的文件标识注释,可以使用反斜杠进行转义。
-
可以使用标准的glob模式匹配。所谓的glob模式是指shell所使用的简化了的正则表达式。
-
以斜杠"/"开头表示目录;"/"结束的模式只匹配文件夹以及在该文件夹路径下的内容,但是不匹配该文件;"/"开始的模式匹配项目跟目录;如果一个模式不包含斜杠,则它匹配相对于当前 .gitignore 文件路径的内容,如果该模式不在 .gitignore 文件中,则相对于项目根目录。
-
以星号"*"通配多个字符,即匹配多个任意字符;使用两个星号"**" 表示匹配任意中间目录,比如`a/**/z`可以匹配 a/z, a/b/z 或 a/b/c/z等。
-
以问号"?"通配单个字符,即匹配一个任意字符;
-
以方括号"[]"包含单个字符的匹配列表,即匹配任何一个列在方括号中的字符。比如[abc]表示要么匹配一个a,要么匹配一个b,要么匹配一个c;如果在方括号中使用短划线分隔两个字符,表示所有在这两个字符范围内的都可以匹配。比如[0-9]表示匹配所有0到9的数字,[a-z]表示匹配任意的小写字母)。
-
以叹号"!"表示不忽略(跟踪)匹配到的文件或目录,即要忽略指定模式以外的文件或目录,可以在模式前加上惊叹号(!)取反。需要特别注意的是:如果文件的父目录已经被前面的规则排除掉了,那么对这个文件用"!"规则是不起作用的。也就是说"!"开头的模式表示否定,该文件将会再次被包含,如果排除了该文件的父级目录,则使用"!"也不会再次被包含。可以使用反斜杠进行转义。
二、.gitignore忽略规则简单说明
规则 | 说明 |
# | 表示此为注释,将被Git忽略 |
*.a | 表示忽略所有 .a 结尾的文件 |
!lib.a | 表示lib.a除外 |
/TODO | 表示仅仅忽略项目根目录下的 TODO 文件,不包括 subdir /TODO |
build/ | 表示忽略 build/目录下的所有文件,过滤整个build文件夹 |
doc/*.txt | 表示会忽略doc /notes .txt但不包括 doc /server/arch .txt |
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 文件 |
/mtk/ | 表示过滤整个文件夹 |
*.zip | 表示过滤所有.zip文件 |
/mtk/do .c |
表示过滤某个具体文件 |
温馨提示:
如果你不慎在创建.gitignore文件之前就push了项目,那么即使你在.gitignore文件中写入新的过滤规则,这些规则也不会起作用,Git仍然会对所有文件进行版本管理。简单来说出现这种问题的原因就是Git已经开始管理这些文件了,所以你无法再通过过滤规则过滤它们。所以大家一定要养成在项目开始就创建.gitignore文件的习惯,否则一单push,处理起来会非常麻烦。
三、.gitignore忽略规则常用示例
1、项目目录下有一个Config.ini文件,不希望上传到git中去,可以在gitignore文件中添加这样的配置:
Config.ini
或者你想忽略所有的.ini文件你可以这样写:
*.ini
2、如果已经提交过的文件或者文件夹怎么办?此时更改.gitignore文件对已经提交的文件是无效的。
(1)首先,编辑.gitignore文件。
(2)然后如果是单个文件,可以使用如下命令从仓库中删除:
git rm --cached publish/xx.dll (删除publish文件夹下的xx.dll)
(3)如果是整个目录
git rm --cached -r publish (删除publish文件夹)
(4)如果文件很多,那么直接
git rm --cached -r .
(5)如果提示某个文件无法忽略,可以添加-f
参数强制忽略。
git rm -f --cached publish/xx.dll
(6)然后更新.gitignore
git add . git commit -m "Update .gitignore"
3、如果有些文件已经被你忽略了,当你使用git add时是无法添加的,比如我忽略了*.class,现在我想把HelloWorld.class添加到git中去:
$ git add HelloWorld.class The following paths are ignored by one of your .gitignore files: HelloWorld.class Use -f if you really want to add them.
git会提示我们这个文件已经被我们忽略了,需要加上-f
参数才能强制添加到git中去:
$ git status On branch master Initial commit Changes to be committed: (use "git rm --cached <file>..." to unstage) new file: .gitignore new file: HelloWorld.class new file: HelloWorld.java
这样就能强制添加到缓存中去了。如果我们意外的将想要忽略的文件添加到缓存中去了,我们可以使用rm命令将其从中移除:
$ git rm HelloWorld.class --cached rm 'HelloWorld.class'
如果你已经把不想上传的文件上传到了git仓库,那么你必须先从远程仓库删了它,我们可以从远程仓库直接删除然后pull代码到本地仓库这些文件就会本删除,或者从本地删除这些文件并且在.gitignore文件中添加这些你想忽略的文件,然后再push到远程仓库。
4、.gitignor忽略规则查看
如果你发下.gitignore写得有问题,需要找出来到底哪个规则写错了,可以用git check-ignore命令检查:
$ git check-ignore -v HelloWorld.class .gitignore:1:*.class HelloWorld.class
可以看到HelloWorld.class匹配到了我们的第一条*.class的忽略规则所以文件被忽略了。
四、忽略规则的三种方法
1、第一种方法配置.gitignore
针对单一工程排除文件,这种方式会让这个工程的所有修改者在克隆代码的同时,也能克隆到过滤规则,而不用自己再写一份,
这就能保证所有修改者应用的都是同一份规则
。配置步骤如下:
在工程根目录下建立.gitignore文件,将要排除的文件或目录 写到.gitignore这个文件中,其中有两种写入方法:
(1)使用命令行增加排除文件
(2)最方便的办法是,用记事本打开,增加需要排除的文件或目录,一行增加一个,例如:
*.class *.apk bin/ gen/ .settings/ proguard/
2、全局设置排除文件
全局设置排除文件,这会在全局起作用,只要是Git管理的工程,在提交时都会自动排除不在控制范围内的文件或目录。这种方法对开发者来说,比较省事,只要一次全局配置,不用每次建立工程都要配置一遍过滤规则。但是这不保证其他的开发者在克隆你的代码后,他们那边的规则跟你
的是一样的,这就带来了代码提交过程中的各种冲突问题。
配置步骤如下:
a)像方法(1)一样,也需要建立一个.gitignore文件,把要排除的文件写进去。
b)但在这里,我们不规定一定要把.gitnore文件放到某个工程下面,而是任何地方,比如我们这里放到了Git默认的Home路径下,比如:
/home/wangshibo/hqsb_ios
c)使用命令方式可以配置全局排除文件:
# git config --global core.excludesfile ~/.gitignore
你会发现在~/.gitconfig文件中会出现excludesfile =
/home/wangshibo/hqsb_ios/
.gitignore。
说明Git把文件过滤规则应用到了Global的规则中。
3、单个工程设置排除文件
在工程目录下找到.git
/info/exclude
,把要排除的文件写进去:
*.class *.apk bin/ gen/ .settings/ proguard/
这种方法就不提倡了,只能针对单一工程配置,而且还不能将过滤规则同步到其他开发者,跟方法一和方法二比较起来没有一点优势。