git：.gitignore的使用

.gitignore的使用

1、简介

.gitignore文件用于指定哪些文件或目录应该被Git忽略，即它们不会被Git跟踪和提交到版本控制中。

2、简单语法规则

1、注释：使用#符号进行注释。

2、文件和目录规则：每行一个规则，指定要忽略的文件、目录或模式。
（1）要忽略特定文件，请直接指定文件路径，例如：example.txt。
（2）要忽略整个目录，请指定目录路径，例如：/my_directory/。
（3）使用通配符进行模式匹配，例如：*.log将忽略所有以.log结尾的文件。
（4）指定以斜杠（/）开头的规则将从存储库的根目录开始匹配，否则将在子目录中递归匹配。
（5）特殊字符转义：如果要匹配包含特殊字符的文件或目录，请使用反斜杠进行转义，例如：special\ file.txt。
（6）目录通配符：使用斜杠（/）指定目录通配符。例如，要忽略所有的.git目录（包括子目录），可以使用**/.git/。

下面是一个示例.gitignore文件的样板：

# 忽略所有 .log 文件
*.log

# 忽略 .env 文件
.env

# 忽略 build 目录
/build/

# 忽略特定目录下的文件
/some_directory/*.txt

# 忽略任意层级的 temp 目录
**/temp/

.gitignore规则只会影响尚未添加到Git版本控制中的文件。如果某些文件已经被Git跟踪并提交，您需要使用git rm命令将其从版本控制中删除，然后再更新.gitignore文件。

3、.gitignore文件失效的可能原因

1、.gitignore未被正确放置：确保.gitignore文件位于存储库的根目录下，并且文件名为.gitignore（注意开头的点）。

2、文件或目录已经被Git跟踪，但.gitignore规则只对尚未添加到Git版本控制中的文件起作用。如果某些文件或目录已经被Git跟踪并提交，.gitignore规则将不会影响它们。需要使用以下命令将这些文件从Git中移除：

git rm --cached <file_or_directory>

# 例如，如果要将名为example.txt的文件从Git中移除：
git rm --cached example.txt

3、缓存未清除：如果已经将某些文件或目录添加到Git版本控制中，并且之后才将它们添加到.gitignore文件中，那么这些文件或目录的更改可能仍然会被Git缓存。可以使用以下命令清除Git缓存：

git rm -r --cached .
git add .

4、应用规则不正确：请确保.gitignore文件中的规则正确匹配要忽略的文件或目录路径。您可以使用通配符和正则表达式来指定更复杂的规则。

5、如果涉及到git子模块：
如果你的存储库中包含子模块（submodule），则应确保在父存储库的.gitignore文件中忽略子模块相关的文件和目录。为了使.gitignore规则在子模块中生效，需要在每个子模块的根目录下单独创建一个.gitignore文件，并将规则添加到子模块的.gitignore文件中。