在使用Git的过程中,我们喜欢有的文件比如日志,临时文件,编译的中间文件等不要提交到代码仓库,这时就要设置相应的忽略规则,来忽略这些文件的提交。
1 项目中忽略
这种方式通过在项目的某个文件夹下定义 .gitignore 文件,在该文件中定义相应的忽略规则,来管理当前文件夹下的文件的Git提交行为。
1、在.git同目录下新增.gitignore文件
vim .gitignore
2、添加需要忽略的内容后,保存即可
# os system file
.DS_Store
.gitignore 文件是可以提交到共有仓库中,这就为该项目下的所有开发者都共享一套定义好的忽略规则。
清除已经上传的多余文件
- 如果你添加.gitignore的时候,git里面已经上传了很多不需要的文件,则使用下面命令删除他们,如删除.DS_Store文件
find . -name .DS_Store -print0 | xargs -0 git rm -f --ignore-unmatch
执行后,删除项目中的所有.DS_Store。这会跳过不在项目中的 .DS_Store。
- 如果只是commit,还没push,可以有两个命令删除(缓存区)他们:
# 删除文件夹
git rm -r --cached ${文件夹名}
# 删除文件
git rm --cached ${文件名}
如删除git项目中所有文件夹下的’.DS_Store’文件:
git rm --cached */.DS_Store
2 全局忽略
在使用Git的过程中,我们喜欢有的文件比如日志,临时文件,编译的中间文件等不要提交到代码仓库,这时就要设置相应的忽略规则,来忽略这些文件的提交。
在电脑上有多个Git项目,每个项目都有不同的忽略文件(.gitignore)列表十分麻烦。
网上查了下,有全局配置忽略的办法,如下:
- 根目录创建全局文件
vim ~/.gitignore_global
- 写入内容
# for Mac OS X System Files
.DS_Store
Thumbs.db
# for Eclipse
*.project
# remove SVN
.svn
# for IDEA
*/build/*
.idea/*
*.iml
/out/*
target/
.idea
*/target
*/*.iml
*.iml
- 生效配置文件
git config --global core.excludesfile ~/.gitignore_global
3 规则与语法
在 .gitingore 文件中,遵循相应的语法,在每一行指定一个忽略规则。
3.1 匹配语法
符号 | 说明 |
---|---|
空格 | 不匹配任意文件,可作为分隔符,可用反斜杠转义 |
# 开头 | 标识注释,可以使用反斜杠进行转义 |
! 开头 | 标识否定,该文件将会再次被包含,如果排除了该文件的父级目录,则使用 ! 也不会再次被包含。可以使用反斜杠进行转义 |
/ 结束 | 只匹配文件夹以及在该文件夹路径下的内容,但是不匹配该文件 |
/ 开始的模式 | 匹配项目跟目录 |
** | 匹配多级目录,可在开始,中间,结束 |
? | 通用匹配单个字符 |
[] | 通用匹配单个字符列表 |
* | 通用匹配多个字符 |
如果一个模式不包含斜杠,则它匹配相对于当前 .gitignore 文件路径的内容,如果该模式不在 .gitignore 文件中,则相对于项目根目录
详细的忽略规则可以参考官方英文文档
3.2 匹配示例
- 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 文件
4 忽略规则优先级
Git 检查忽略规则的时候有多个来源,它的优先级如下(由高到低):
- 从命令行中读取可用的忽略规则
- 当前目录定义的规则
- 父级目录定义的规则,依次地推
- $GIT_DIR/info/exclude 文件中定义的规则
- core.excludesfile中定义的全局规则
5 .gitignore规则不生效
.gitignore只能忽略那些原来没有被track的文件,如果某些文件已经被纳入了版本管理中,则修改.gitignore是无效的。
解决方法就是先把本地缓存删除(改变成未track状态),然后再提交:
git rm -r --cached .
git add .
git commit -m 'update .gitignore'