git忽略特殊文件不提交

清疚 2022-05-27 00:17 280阅读 0赞

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

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

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

忽略文件的原则是：

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

举个例子：

假设你在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行规则忽略了该文件，于是我们就可以知道应该修订哪个规则。

### 小结 ###

*  忽略某些文件时，需要编写`.gitignore`；
 *  `.gitignore`文件本身要放到版本库里，并且可以对`.gitignore`做版本管理！

#     #

# source tree 如何忽略文件 #

在使用git时经常会遇到项目中的一些文件不需要跟踪，可以使用以下两种方法忽略不需要跟踪的文件：

方法一：从文件的菜单按钮中忽略文件

![20170228102805640][]

方法二：编辑.gitignore文件

1. 进入 设置-高级，会看到“仓库指定忽略列表”，并点击编辑

![20170228104211069][]

点击“编辑”后进入.gitignore编辑页面：

![20170228104410806][]

2. .gitignore文件编辑：

忽略指定文件：直接写文件名

忽略文件夹：直接写文件夹路径，例：target或者target/ -> 忽略target下的所有文件

忽略某类型的文件：使用通配符\*，例：\*.class -> 忽略所有.class文件

[https_github.com_github_gitignore]: https://github.com/github/gitignore
[20170228102805640]: /images/20220527/46179eb32a6a4bc7a3382398e03dfa3c.png
[20170228104211069]: /images/20220527/2dfad5e52e5f4e58bbe73a0a6450cfd3.png
[20170228104410806]: /images/20220527/f563fd97044b4c1ca79ce0d2675a4ba6.png