在使用Git的过程中,我们希望有的文件不要提交到代码仓库,比如日志,临时文件,编译的中间文件等。这时候就要设置相应的忽略规则,来忽略这些文件的提交。
Git为我们提供了一个 .gitignore 文件,只要在这个文件里声明哪些文件你不希望添加到Git中去,这样当你使用 git add . 的时候这些文件就会被自动忽略。

实现Git忽略提交的三种方法

在Git项目中定义.gitignore文件

这种方式通过在项目中的某个文件下定义 .gitignore 文件,在该文件中定义相应的忽略规则,来管理当前文件夹下的文件的Git提交行为。.gitignore 文件是可以提交到公有仓库中,这就为该项目下的所有开发者都共享一套定义好的忽略规则。
.gitignore 文件中,遵循相应的语法,在每一行指定一个忽略规则。

  1. *.log
  2. *.temp
  3. /vendor

在Git项目的设置中指定排除文件

这种方法只是临时指定该项目的行为,需要编辑当前项目下的 .git/info/exclude 文件,然后将需要忽略提交的文件写入其中。
需要注意的是,这种方式指定的忽略文件的根目录是项目根目录。

定义Git全局的.gitignore文件

除了可以在项目中定义.gitignore 文件外,还可以设置全局的.gitignore 文件来管理所有Git项目的行为。这种方式在不同的项目开发者之间是不共享的,是属于项目之上Git应用级别的行为。这种方式也需要创建相应的.gitignore 文件,可以放在任意位置,然后通过以下命令配合Git。

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

Git忽略文件的原则

  • 忽略操作系统自动生成的文件,比如缩略图等。
  • 忽略编译生成的中间文件、可执行元件等,也就是如果一个文件是通过另一个文件自动生成的,那自动生成的文件就没必要放进版本库,比如Java编译产生的 .class 文件。
  • 忽略你自己的带有敏感信息的配置文件,比如存放口令的配置文件。

    .gitignore文件的使用方法

    首先,在你的工作区新建一个名为.gitignore 的文件。然后把要忽略的文件名填进去,Git就会自动忽略这些文件。

    .gitignore忽略规则的优先级

    .gitignore 文件中,每一行指定一个忽略规则,Git检查忽略规则的时候有多个来源,它的优先级如下(由高到低):
  1. 从命令行中读取可用的忽略规则
  2. 当前目录定义的规则
  3. 父级目录定义的规则,依次递推
  4. $GIT_DIR/info/exclude 文件中定义的规则
  5. core.excludesfile 中定义的全局规则

    .gitignore忽略规则的匹配语法

    .gitignore 文件中,每一行的忽略规则的语法如下:
  • 空格不匹配任意文件,可作为分隔符,可以用反斜杠转义
  • 以“#”开头的行都会被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]表示匹配任意的小写字母。
  • 以叹号“!”表示不忽略跟踪匹配到的文件或目录,即要忽略指定模式以外的文件或目录,可以在模式前加上惊叹号取反。需要特别注意的是:如果文件的父目录已经被前面的规则排除掉了,那么对这个文件用“!”规则是不起作用的。
  • git对于.ignore配置文件是按行从上到下进行规则匹配的,意味着如果前面的规则匹配的范围更大,则后面的规则将不会生效

    .gitignore忽略规则简单说明

    ```shell

    表示此为注释,将被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 表示过滤某个具体文件

被过滤掉的文件就不会出现在git仓库中(gitlab或github)了,当然本地库中还有,只是push的时候不会上传。

需要注意的是,gitignore还可以指定要将哪些文件添加到版本管理中,如下: !*.zip !/mtk/one.txt

唯一的区别就是规则开头多了一个感叹号,Git会将满足这类规则的文件添加到版本管理中。为什么要有两种规则呢? 想象一个场景:假如我们只需要管理/mtk/目录中的one.txt文件,这个目录中的其他文件都不需要管理,那么.gitignore规则应写为:: /mtk/* !/mtk/one.txt

假设我们只有过滤规则,而没有添加规则,那么我们就需要把/mtk/目录下除了one.txt以外的所有文件都写出来! 注意上面的/mtk/*不能写为/mtk/,否则父目录被前面的规则排除掉了,one.txt文件虽然加了!过滤规则,也不会生效!


还有一些规则如下: fd1/* 说明:忽略目录 fd1 下的全部内容;注意,不管是根目录下的 /fd1/ 目录,还是某个子目录 /child/fd1/ 目录,都会被忽略;

/fd1/* 说明:忽略根目录下的 /fd1/ 目录的全部内容;

/ !.gitignore !/fw/ /fw/ !/fw/bin/ !/fw/sf/ 说明:忽略全部内容,但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录;注意要先对bin/的父目录使用!规则,使其不被排除。

如果你不慎在创建 `.gitignore` 文件之前就 `push` 了项目,那么即使你在 `.gitignore` 文件中写入新的过滤规则,这些规则也不会起作用,Git仍然会对所有文件进行版本管理。简单来说出现这种问题的原因就是Git已经开始管理这些文件了,所以你无法再通过过滤规则过滤它们。所以大家一定要养成在项目开始就创建.gitignore文件的习惯,否则一单push,处理起来会非常麻烦。
<a name="zPft9"></a>
# .gitignore忽略规则查看
如果你发现 `.gitignore` 写得有问题,需要找出来到底哪个规则写错了,可以用 `git check-ignore` 命令检查。
```shell
$ git check-ignore -v HelloWorld.class
.gitignore:1:*.class    HelloWorld.class

可以看到HelloWorld.class匹配到了一条*.class的忽略规则所以文件被忽略了。

Git忽略规则(.gitignore配置)不生效原因和解决

.gitignore 中已经标明忽略的文件目录下的文件, git push 的时候还会出现在 push 的目录中,或者用 git status 查看状态,想要忽略的文件还是显示被追踪状态。
原因是因为在git忽略目录中,新建的文件在git中会有缓存,如果某些文件已经被纳入了版本管理中,就算是在 .gitignore 中已经声明了忽略路径也是不起作用的,
这时候我们就应该先把本地缓存删除,然后再进行git的提交,这样就不会出现忽略的文件了。

# git清除本地缓存(改变成未track状态),然后再提交
git rm -r --cached .
git add .
git commit -m 'update .gitignore'
git push -u origin master

需要特别注意的是:

  • .gitignore 只能忽略那些原来没有被track的文件,如果某些文件已经被纳入了版本管理中,则修改 .gitignore 是无效的。
  • 想要 .gitignore 起作用,必须要在这些文件不在暂存区中才可以, .gitignore 文件只是忽略没有被staged(cached)文件,

    对于已经被staged文件,加入ignore文件时一定要先从staged移除,才可以忽略。

还有一种方法,就是在每个 clone 下来的仓库中手动设置不要检查特定文件的更改情况。

git update-index --assume-unchanged PATH