在Windows上忽略Git仓库中的目录

技术背景

在使用Git进行项目管理时，有些文件或目录我们不希望被纳入版本控制，如临时文件、日志文件、依赖库文件等。这时就需要使用 .gitignore 文件或仓库排除规则来告诉Git忽略这些内容。在Windows系统上操作时，由于系统特性，创建和使用 .gitignore 文件会有一些特殊注意事项。

实现步骤

1. 创建 .gitignore 文件

• 在项目根目录下创建一个名为 .gitignore 的文件。在Windows资源管理器中，由于不能直接创建只有扩展名的文件，可以先创建一个空文本文件，然后在命令提示符中使用 ren 命令重命名，例如：

ren "New Text Document.txt" .gitignore

也可以在命令行中使用 echo > .gitignore 直接创建。

2. 向 .gitignore 文件中添加要忽略的目录

在 .gitignore 文件中，通过添加目录名（后面加上斜杠）来忽略该目录，例如：

dir_to_ignore/

还可以使用通配符忽略特定格式的文件，如 *.txt 表示忽略所有 .txt 文件。

3. 全局忽略配置

可以创建一个全局的 .gitignore 文件，例如 ~/.gitignore_global，然后运行以下命令将其添加到Git配置中：

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

4. 仓库排除规则

对于不需要共享的本地文件，可以将文件模式或目录添加到 .git/.info/exclude 文件中。这些规则不会被提交，其他用户无法看到。

5. 忽略目录中的所有内容

如果要忽略整个目录的内容，可以在该目录下的 .gitignore 文件中写入 *，例如：

# /root/dirB/.gitignore
*

6. 临时忽略已在Git中的目录/文件

如果想要临时忽略已在Git中的目录或文件，可以按以下步骤操作：

1. 删除不需要的文件和文件夹。
2. 验证构建仍然正常工作。
3. 运行以下命令让Git暂时忽略已删除的文件：

git ls-files --deleted -z | git update-index --assume-unchanged -z --stdin

4. 当需要恢复这些文件时，运行以下命令：

git ls-files --deleted -z | git update-index --no-assume-unchanged -z --stdin

核心代码

创建 .gitignore 文件

# 在Windows上创建 .gitignore 文件
echo > .gitignore

# 在Unix上创建 .gitignore 文件
touch .gitignore

重命名文件为 .gitignore

ren "New Text Document.txt" .gitignore

忽略已删除的文件

git ls-files --deleted -z | git update-index --assume-unchanged -z --stdin

恢复忽略的文件

git ls-files --deleted -z | git update-index --no-assume-unchanged -z --stdin

最佳实践

• 使用全局和局部配置结合：对于通用的应忽略的文件和目录，使用全局 .gitignore_global 配置；对于项目特定的内容，使用项目根目录下的 .gitignore 文件。
• 定期清理和维护 .gitignore 文件：随着项目的发展，可能会有新的文件或目录需要忽略，也可能有些内容不再需要忽略，定期检查和更新 .gitignore 文件，保证其有效性。

常见问题

1. 无法在Windows资源管理器中创建 .gitignore 文件

由于Windows资源管理器要求文件必须有名称和扩展名，不能直接创建只有扩展名的文件。可以通过上述提及的命令行重命名或创建 .gitignore 文件。

2. .gitignore.txt 文件不生效

Git只识别 .gitignore 文件，不使用 .gitignore.txt。需要将文件重命名为 .gitignore。

3. Git未正确识别 .gitignore 文件

在Windows上有时会遇到Git无法正确识别 .gitignore 文件的情况。这时可以尝试编辑 .git/info/exclude 文件，将需要忽略的目录添加到该文件末尾，但要注意该文件不会被提交和共享。

4. 已被跟踪的文件仍然显示在 git status 中

如果某个文件之前已经被Git跟踪，即使在 .gitignore 中添加了该文件，它仍然会显示在 git status 中。可以使用 git rm --cached filename 命令将其从Git的跟踪列表中移除。