git ignore忽略规则

目录

• Git 忽略文件提交的方法
• Git 忽略规则
  • Git 忽略规则优先级
  • Git 忽略规则匹配语法
    • 常用匹配示例
  • 多级目录忽略规则设置
  • .gitignore规则不生效
• 参考文章

Git 忽略文件提交的方法

有三种方法可以实现忽略Git中不想提交的文件。具体详情可查看文首link的官方文档。

1. 在Git项目中定义 .gitignore文件

在项目的某个文件夹下定义.gitignore文件，在该文件中定义相应的忽略规则，来管理当前文

件夹下的文件的Git提交行为。.gitignore 文件是可以提交到共有仓库中，这就为该项目下的所有开发者都共享一套定义好的忽略规则。

在 .gitingore 文件中，遵循相应的语法，在每一行指定一个忽略规则。如：

*.log
*.temp
/vendor

1. 定义Git全局的.gitignore 文件

除了可以在项目中定义 .gitignore 文件外，还可以设置全局的 .gitignore 文件来管理所有Git项目的行为。这种方式在不同的项目开发者之间是不共享的，是属于项目之上Git应用级别的行为。

这种方式也需要创建相应的 .gitignore 文件，可以放在任意位置。然后在使用以下命令配置Git：

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

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

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

需要注意的是，这种方式指定的忽略文件的根目录是项目根目录。

Git 忽略规则

详细的忽略规则可以参考官方英文文档

Git 忽略规则优先级

在 .gitingore 文件中，每一行指定一个忽略规则，Git 检查忽略规则的时候有多个来源，它的优先级如下（由高到低）：

• 从命令行中读取可用的忽略规则
• 当前目录定义的规则
• 父级目录定义的规则，依次地推
• $GIT_DIR/info/exclude 文件中定义的规则
• core.excludesfile中定义的全局规则

Git 忽略规则匹配语法

在 .gitignore 文件中，每一行的忽略规则的语法如下：

• 空格 不匹配任意文件，可作为分隔符，可用反斜杠转义
• #开头 标识注释，可以使用反斜杠进行转义
• !开头 标识否定，该文件将会再次被包含，如果排除了该文件的父级目录，则使用 ! 也不会再次被包含。可以使用反斜杠进行转义
• /结束 只匹配文件夹以及在该文件夹路径下的内容，但是不匹配该文件
• /开始 匹配项目根目录

如果一个模式不包含斜杠，则它匹配相对于当前 .gitignore 文件路径的内容，如果该模式不在该路径中，则相对于项目根目录

• ** 匹配多级目录，可在开始，中间，结束
• * 通配多个字符；
• ? 通用匹配单个字符
• [] 通用匹配单个字符列表

注意：如果你创建.gitignore文件之前就push了某一文件，那么即使你在.gitignore文件中写入过滤该文件的规则，该规则也不会起作用，git仍然会对该文件进行版本管理。

注意： git 对于 .gitignore配置文件是按行从上到下进行规则匹配的

常用匹配示例

• 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/do.c: 过滤某个具体文件
• !/mtk/one.txt: 追踪（不过滤）某个具体文件

多级目录忽略规则设置

现有以下目录结构：

• 假设引用场景(一)

忽略 aaa目录，但是需要管理aaa目录下的bbb.txt,除此之外，其他文件均不需要管理

#忽略aaa/下的所有文件，注意是aaa/*,而不是aaa/,
aaa/*
#不忽略aaa/bbb.txt
!aaa/bbb.txt

结果：

xx$ git status
On branch master
Your branch is up to date with 'origin/master'.

Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)

    new file:   aaa/bbb.txt

• 假设引用场景(二)

继续场景（一）的需求，还需要管理ddd目录下的eee.txt，除此之外，其他文件均不需要管理

#忽略aaa/下的所有文件，注意是aaa/*,而不是aaa/,
aaa/*
#不忽略aaa/bbb.txt
!aaa/bbb.txt
#不忽略aaa/ddd/
!aaa/ddd/
#忽略aaa/ddd 的所有文件
aaa/ddd/*
#不忽略aaa/ddd/eee.txt
!aaa/ddd/eee.txt

结果：

 xx$ git status
On branch master
Your branch is up to date with 'origin/master'.

Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)

    new file:   aaa/bbb.txt
    new file:   aaa/ddd/eee.txt

以此类推，在需要管理多级目录下的某个文件时，需要首先对上级目录"!"不忽略，然后对目录下"*"忽略所有文件，最后对目录下"!"不忽略该文件。

.gitignore规则不生效

.gitignore只能忽略那些原来没有被track的文件，如果某些文件已经被纳入了版本管理中，则修改.gitignore是无效的。

解决方法就是先把本地缓存删除（改变成未track状态），然后再提交:

git rm -r --cached .
git add .
git commit -m 'update .gitignore'

参考文章

Git 忽略提交 .gitignore - 简书