应用场景

git add [file1｜dir] 命令可将文件添加到暂存区。但是在文件比较多的时候，一个个添加比较麻烦，所以一般使用git add . 添加当前目录下的所有文件到暂存区。

但是这也带来一个问题：当前目录下有些文件是我不想提交的(比如以.开头的一些文件)，git add .会默认把这些也添加到暂存区。

我们希望可以在一个地方进行设置，这样当我们使用git add .的时候可以避开一些我们不希望提交上去的文件。这个用来设置的地方就是gitignore文件。

使用方法

位置以及作用范围

  • .gitignore文件可以放在任意目录下
  • 一个git项目中可以含有多个.gitignore文件
  • 每个.gitigore文件只对该.gitignore文件所处目录和其子目录有作用。
  • 除了上述使用方法外，gitignore也可以配置全局生效。

gitignore怎么写

语法规则(可以不用看直接找自己需要的复制过去即可)

参考：https://git-scm.com/docs/gitignore

在 .gitignore 文件中，每一行的忽略规则的语法如下：

  • 空格不匹配任意文件，可作为分隔符，可用反斜杠转义
  • 以“＃”开头的行都会被 Git 忽略。即#开头的文件标识注释，可以使用反斜杠进行转义。
  • 可以使用标准的glob模式匹配。所谓的glob模式是指shell所使用的简化了的正则表达式。
  • 以斜杠"/“开头表示目录；”/“结束的模式只匹配文件夹以及在该文件夹路径下的内容，但是不匹配该文件；”/"开始的模式匹配项目跟目录；如果一个模式不包含斜杠，则它匹配相对于当前 .gitignore 文件路径的内容，如果该模式不在 .gitignore 文件中，则相对于项目根目录。

假如说我们希望过滤掉src/build文件夹下的所有内容，我们可以这么写：src/build/那么这个路径下的所有内容都会被忽略，这个路径是相对路径。

  • 以星号"*“通配多个字符，即匹配多个任意字符；使用两个星号”**" 表示匹配任意中间目录，比如a/**/z可以匹配 a/z, a/b/z 或 a/b/c/z等。

比如src/**/build，可以匹配到src/test/build，也可以匹配到src/current/build。

  • 以问号"?"通配单个字符，即匹配一个任意字符；
  • 以方括号"[]"包含单个字符的匹配列表，即匹配任何一个列在方括号中的字符。比如[abc]表示要么匹配一个a，要么匹配一个b，要么匹配一个c；如果在方括号中使用短划线分隔两个字符，表示所有在这两个字符范围内的都可以匹配。比如[0-9]表示匹配所有0到9的数字，[a-z]表示匹配任意的小写字母）。
  • 以叹号"!“表示不忽略(跟踪)匹配到的文件或目录，即要忽略指定模式以外的文件或目录，可以在模式前加上惊叹号（!）取反。需要特别注意的是：如果文件的父目录已经被前面的规则排除掉了，那么对这个文件用”!“规则是不起作用的。也就是说”!“开头的模式表示否定，该文件将会再次被包含，如果排除了该文件的父级目录，则使用”!"也不会再次被包含。可以使用反斜杠进行转义。

比如说我们想要保留src/build路径下叫做main.go的文件，那么我们可以加上一行：!main.go

**注意：**git对于.ignore配置文件是按行从上到下进行规则匹配的，意味着如果前面的规则匹配的范围更大，则后面的规则将不会生效；

gitignore示例
#注释           .gitignore的注释
*.txt           忽略所有 .txt 后缀的文件
!src.a          忽略除 src.a 外的其他文件
/todo           仅忽略项目根目录下的 todo 文件，不包括 src/todo
build/          忽略 build/目录下的所有文件，过滤整个build文件夹；
doc/*.txt       忽略doc目录下所有 .txt 后缀的文件，但不包括doc子目录的 .txt 的文件
 
bin/:           忽略当前路径下的 bin 文件夹，该文件夹下的所有内容都会被忽略，不忽略 bin 文件
/bin:           忽略根目录下的 bin 文件
/*.c:           忽略 cat.c，不忽略 build/cat.c
debug/*.obj:    忽略debug/io.obj，不忽略 debug/common/io.obj和tools/debug/io.obj
**/foo:         忽略/foo, a/foo, a/b/foo等
a/**/b:         忽略a/b, a/x/b, a/x/y/b等
!/bin/run.sh    不忽略bin目录下的run.sh文件
*.log:          忽略所有 .log 文件
config.js:      忽略当前路径的 config.js 文件
 
/mtk/           忽略整个文件夹
*.zip           忽略所有.zip文件
/mtk/do.c       忽略某个具体文件
gitignore模板

https://github.com/github/gitignore

操作步骤

首先创建gitignore文件

.gitignore是文件名，而不是扩展名。所以，如果你选择在windows下，手动创建该文件，在创建时，应命名为.gitignore.，将文件扩展名置空。

在VSCODE等ide下创建.gitignore则可以直接命名为.gitignore，即会被智能识别。

  • 以linux为例
touch .gitignore

填入内容

根据上述规则写gitignore文件或者粘贴来自其他模板的内容。

例如这里忽略所有 .log 文件，忽略当前路径的 config.js 文件，忽略整个mtk文件夹。

*.log:          
config.js:      
/mtk/

完成

然后正常上传文件即可在git add .这一步忽略掉文件内指定的内容。

已经提交过的处理方法

.gitignore只能忽略那些原来没有被track的文件，如果某些文件已经被纳入了版本管理中，则修改.gitignore是无效的。
解决方法就是先把本地缓存删除（改变成未track状态），然后再提交:

git rm -r --cached . // 删除本地缓存
git add . // 添加要提交的文件
git commit -m "update .gitignore" // 更新本地的缓存
git config core.excludesfile .gitignore //让配置文件生效

全局配置

  • 首先在用户目录文件夹下创建gitignore文件，以linux为例
touch ~/.gitignore
  • 然后填充gitignore文件
  • 执行命令使配置文件生效
git config –global core.excludesFile ~/gitnore
  • 输入查看命令git config --list，查看是否配置成功