Git 忽略指定文件夹

引言

在使用 Git 进行版本控制时，有时我们希望忽略某些文件夹或文件，使它们不被 Git 跟踪、提交或推送到远程仓库中。这样可以避免不必要的麻烦和冲突，同时也保护了一些私密或敏感的信息。本文将详细介绍如何在 Git 中忽略指定文件夹。

文件忽略的原理

在 Git 中，文件忽略是通过 .gitignore 文件来实现的。.gitignore 文件通常位于项目的根目录下，或者在需要忽略的文件夹内部也可以创建一个独立的 .gitignore 文件。在这个文件中，我们可以列出要忽略的文件、文件夹或特定的文件类型的规则。

Git 使用简单的模式匹配规则来判断文件是否被忽略。这些规则可以是准确的文件名、路径或通配符。Git 将忽略匹配到的文件或文件夹，不再对其进行跟踪和提交。

创建 .gitignore 文件

首先，我们需要在项目的根目录下创建一个名为 .gitignore 的文件。在终端或命令行中进入项目目录，并执行如下命令：

$ touch .gitignore

这样，一个空的 .gitignore 文件就创建好了。

添加忽略规则

在 .gitignore 文件中，每一行代表一个忽略规则。以下是一些常见的示例规则：

• 忽略某个文件夹或目录：

  folder/

或者

  /path/to/folder/

表示忽略名为 folder 的文件夹或目录。你可以根据需要更改文件夹的路径。

• 忽略某个特定文件：

  filename.txt

表示忽略名为 filename.txt 的文件。

• 忽略某个特定文件类型：

  *.txt

表示忽略所有以 .txt 结尾的文件。

• 使用通配符进行部分模糊匹配：

  folder/*.txt

表示忽略 folder 文件夹下的所有以 .txt 结尾的文件。

• 使用双星号进行递归匹配：

  **/filename.txt

表示忽略所有目录下名为 filename.txt 的文件。

注意：忽略规则匹配的是相对于 .gitignore 文件所在位置的路径。如果 .gitignore 文件位于项目根目录，那么所有的匹配规则都是基于项目根目录展开的。

你可以根据自己的需要和项目的情况定义适合的忽略规则。可以使用 * 来匹配任意字符，使用 ? 来匹配任意单个字符，使用 ! 来表示不忽略。

示例

下面是一个示例项目结构：

project/
|-- .gitignore
|-- src/
|   |-- main.py
|   |-- utils.py
|-- data/
|   |-- data.txt
|-- README.md

我们希望忽略 data 文件夹和 main.py 文件。此时可以编辑 .gitignore 文件，添加如下规则：

data/
src/main.py

保存并关闭 .gitignore 文件，然后进行提交与推送操作。Git 将会忽略 data 文件夹和 main.py 文件。

下面是一个对忽略规则进行测试的示例：

# 创建测试目录及文件
mkdir test touch test/file1.txt
touch test/file2.txt touch test/file3.csv

git init
Initialized empty Git repository in /path/to/project/.git/

# 编辑 .gitignore 文件 nano .gitignore

# 添加如下规则
test/
*.csv

# 保存并关闭 .gitignore 文件

# 查看 Git 状态
$ git status -s

运行以上命令后，你会看到以下输出：

?? .gitignore

这表示 .gitignore 文件已经被成功跟踪。同时，你会注意到 test 文件夹 和 file3.csv 文件并未出现在未暂存的文件列表中。说明它们已被成功忽略。

忽略已经被跟踪的文件

有时候，在某些特殊情况下，我们可能需要忽略已经被 Git 跟踪的文件或文件夹。这时，只修改 .gitignore 并不能实现目的，因为 Git 仍然会继续对其进行跟踪。

针对这种情况，我们需要运行以下命令：

$ git rm --cached <filename>
$ git rm -r --cached <foldername>

这些命令将会从 Git 的索引中移除已被跟踪的文件或文件夹，但仍然保留在本地工作区。这样，Git 在之后的提交和推送操作中将不再对这些文件进行跟踪。

示例：

假设我们想忽略之前示例中的 main.py 文件，但它已经被跟踪。我们可以运行以下命令：

$ git rm --cached src/main.py

然后再次查看 Git 的状态：

$ git status -s

你会看到 ?? .gitignore 和 D src/main.py，表示 .gitignore 文件已被跟踪，而 main.py 文件已被成功移除跟踪。

结论

通过使用 .gitignore 文件，我们可以方便地在 Git 中忽略指定的文件夹或文件。这对于保护敏感信息、避免冲突以及减少不必要的提交非常有用。本文提供了一些常见的忽略规则示例，并给出了相关的命令和操作解释。