忽略特殊文件

623次阅读

没有评论

共计 2097 个字符，预计需要花费 6 分钟才能阅读完成。

有些时候，你必须把某些文件放到 Git 工作目录中，但又不能提交它们，比如保存了数据库密码的配置文件啦，等等，每次 git status 都会显示Untracked files ...，有强迫症的童鞋心里肯定不爽。

好在 Git 考虑到了大家的感受，这个问题解决起来也很简单，在 Git 工作区的根目录下创建一个特殊的 .gitignore 文件，然后把要忽略的文件名填进去，Git 就会自动忽略这些文件。

注意

.gitignore文件本身应该提交给 Git 管理，这样可以确保所有人在同一项目下都使用相同的 .gitignore 文件。

不需要从头写 .gitignore 文件，GitHub 已经为我们准备了各种配置文件，只需要组合一下就可以使用了。所有配置文件可以直接在线浏览：GitHub/gitignore

忽略文件的原则是：

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

举个例子：

假设你在 Windows 下进行 Python 开发，Windows 会自动在有图片的目录下生成隐藏的缩略图文件，如果有自定义目录，目录下就会有 Desktop.ini 文件，因此你需要忽略 Windows 自动生成的垃圾文件：

# Windows:
Thumbs.db
ehthumbs.db
Desktop.ini

然后，继续忽略 Python 编译产生的 .pyc、.pyo、dist 等文件或目录：

# Python:
*.py[cod]
*.so
*.egg
*.egg-info
dist
build

加上你自己定义的文件，最终得到一个完整的 .gitignore 文件，内容如下：

# Windows:
Thumbs.db
ehthumbs.db
Desktop.ini

# Python:
*.py[cod]
*.so
*.egg
*.egg-info
dist
build

# My configurations:
db.ini
deploy_key_rsa

最后一步就是把 .gitignore 也提交到 Git，就完成了！当然检验 .gitignore 的标准是 git status 命令是不是说working directory clean。

使用 Windows 的童鞋注意了，如果你在资源管理器里新建一个 .gitignore 文件，它会非常弱智地提示你必须输入文件名，但是在文本编辑器里“保存”或者“另存为”就可以把文件保存为 .gitignore 了。

有些时候，你想添加一个文件到 Git，但发现添加不了，原因是这个文件被 .gitignore 忽略了：

$ git add App.class
The following paths are ignored by one of your .gitignore files:
App.class
Use -f if you really want to add them.

如果你确实想添加该文件，可以用 -f 强制添加到 Git：

$ git add -f App.class

或者你发现，可能是 .gitignore 写得有问题，需要找出来到底哪个规则写错了，可以用 git check-ignore 命令检查：

$ git check-ignore -v App.class
.gitignore:3:*.class	App.class

Git 会告诉我们，.gitignore的第 3 行规则忽略了该文件，于是我们就可以知道应该修订哪个规则。

还有些时候，当我们编写了规则排除了部分文件时：

# 排除所有. 开头的隐藏文件:
.*
# 排除所有.class 文件:
*.class

但是我们发现 .* 这个规则把 .gitignore 也排除了，并且 App.class 需要被添加到版本库，但是被 *.class 规则排除了。

虽然可以用 git add -f 强制添加进去，但有强迫症的童鞋还是希望不要破坏 .gitignore 规则，这个时候，可以添加两条例外规则：

# 排除所有. 开头的隐藏文件:
.*
# 排除所有.class 文件:
*.class

# 不排除.gitignore 和 App.class:
!.gitignore
!App.class

把指定文件排除在 .gitignore 规则外的写法就是!+ 文件名，所以，只需把例外文件添加进去即可。

可以通过 GitIgnore Online Generator 在线生成 .gitignore 文件并直接下载。

最后一个问题：.gitignore文件放哪？答案是放 Git 仓库根目录下，但其实一个 Git 仓库也可以有多个 .gitignore 文件，.gitignore文件放在哪个目录下，就对哪个目录（包括子目录）起作用。

myproject          <- Git 仓库根目录
├── .gitigore      <- 针对整个仓库生效的.gitignore
├── LICENSE
├── README.md
├── docs
│   └── .gitigore  <- 仅针对 docs 目录生效的.gitignore
└── source