Git忽略提交规则,.gitignore文件基本使用说明

185次阅读
没有评论

Git 忽略提交规则,.gitignore 文件基本使用说明

.gitignore文件只要在这个文件中申明那些文件你不希望添加到 git 中去,这样当你使用 git add . 的时候这些文件就会被自动忽略掉。

Git 忽略文件的原则

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

.gitignore 文件的使用方法

首先,在你的工作区新建一个名称为.gitignore 的文件。

然后,把要忽略的文件名填进去,Git 就会自动忽略这些文件。

有时对于 git 项目下的某些文件,我们不需要纳入版本控制,比如日志文件或者 IDE 的配置文件,此时可以在项目的根目录下建立一个隐藏文件 .gitignore(linux 下以. 开头的文件都是隐藏文件),然后在.gitignore 中写入需要忽略的文件。

[root@kevin ~]# cat .gitignore
*.xml
*.log
*.apk

.gitignore 注释用 ’#’, * 表示匹配 0 个或多个任意字符,所以上面的模式就是要忽略所有的 xml 文件,log 文件和 apk 文件。

.gitignore 配置文件用于配置不需要加入版本管理的文件,配置好该文件可以为版本管理带来很大的便利。

.gitignore 忽略规则的优先级

在 .gitingore 文件中,每一行指定一个忽略规则,Git 检查忽略规则的时候有多个来源,它的优先级如下(由高到低):

  • 1)从命令行中读取可用的忽略规则
  • 2)当前目录定义的规则
  • 3)父级目录定义的规则,依次递推
  • 4)$GIT_DIR/info/exclude 文件中定义的规则
  • 5)core.excludesfile 中定义的全局规则

.gitignore 忽略规则的匹配语法

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

  • 1)空格 不匹配任意文件,可作为分隔符,可用反斜杠转义
  • 2)以“#”开头的行都会被 Git 忽略。即 #开头的文件标识注释,可以使用反斜杠进行转义。
  • 3)可以使用标准的 glob 模式匹配。所谓的 glob 模式是指 shell 所使用的简化了的正则表达式。
  • 4)以斜杠 ”/“ 开头表示目录;”/” 结束的模式只匹配文件夹以及在该文件夹路径下的内容,但是不匹配该文件;”/” 开始的模式匹配项目跟目录;如果一个模式不包含斜杠,则它匹配相对于当前 .gitignore 文件路径的内容,如果该模式不在 .gitignore 文件中,则相对于项目根目录。
  • 5)以星号 ”*“ 通配多个字符,即匹配多个任意字符;使用两个星号 ”**” 表示匹配任意中间目录,比如 `a/**/z` 可以匹配 a/z, a/b/z 或 a/b/c/ z 等。
  • 6)以问号 ”?“ 通配单个字符,即匹配一个任意字符;
  • 7)以方括号 ”[]“ 包含单个字符的匹配列表,即匹配任何一个列在方括号中的字符。比如 [abc] 表示要么匹配一个 a,要么匹配一个 b,要么匹配一个 c;如果在方括号中使用短划线分隔两个字符,表示所有在这两个字符范围内的都可以匹配。比如 [0-9] 表示匹配所有 0 到 9 的数字,[a-z]表示匹配任意的小写字母)。
  • 8)以叹号 ”!“ 表示不忽略 (跟踪) 匹配到的文件或目录,即要忽略指定模式以外的文件或目录,可以在模式前加上惊叹号(!)取反。需要特别注意的是:如果文件的父目录已经被前面的规则排除掉了,那么对这个文件用 ”!” 规则是不起作用的。也就是说 ”!” 开头的模式表示否定,该文件将会再次被包含,如果排除了该文件的父级目录,则使用 ”!” 也不会再次被包含。可以使用反斜杠进行转义。

需要谨记:git 对于.ignore 配置文件是按行从上到下进行规则匹配的,意味着如果前面的规则匹配的范围更大,则后面的规则将不会生效;

.gitignore 忽略规则简单说明

# 表示此为注释, 将被 Git 忽略
*.a 表示忽略所有 .a 结尾的文件
!lib.a 表示但 lib.a 除外
/TODO 表示仅仅忽略项目根目录下的 TODO 文件,不包括 subdir/TODO
build/ 表示忽略 build/ 目录下的所有文件,过滤整个 build 文件夹;
doc/*.txt 表示会忽略 doc/notes.txt 但不包括 doc/server/arch.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.php: 表示忽略当前路径的 config.php 文件
/mtk/ 表示过滤整个文件夹
*.zip 表示过滤所有.zip 文件
/mtk/do.c 表示过滤某个具体文件

被过滤掉的文件就不会出现在 git 仓库中(gitlab 或 github)了,当然本地库中还有,只是 push 的时候不会上传。

需要注意的是,gitignore 还可以指定要将哪些文件添加到版本管理中,如下:

!*.zip
!/mtk/one.txt

唯一的区别就是规则开头多了一个感叹号,Git 会将满足这类规则的文件添加到版本管理中。为什么要有两种规则呢?

想象一个场景:假如我们只需要管理 /mtk/ 目录中的 one.txt 文件,这个目录中的其他文件都不需要管理,那么.gitignore 规则应写为

/mtk/*
!/mtk/one.txt

假设我们只有过滤规则,而没有添加规则,那么我们就需要把 /mtk/ 目录下除了 one.txt 以外的所有文件都写出来!

注意上面的 /mtk/* 不能写为 /mtk/,否则父目录被前面的规则排除掉了,one.txt 文件虽然加了! 过滤规则,也不会生效!

还有一些规则如下:

fd1/*

说明:忽略目录 fd1 下的全部内容;注意,不管是根目录下的 /fd1/ 目录,还是某个子目录 /child/fd1/ 目录,都会被忽略;

/fd1/*

说明:忽略根目录下的 /fd1/ 目录的全部内容;

/*
!.gitignore
!/fw/
/fw/*
!/fw/bin/
!/fw/sf/

说明:忽略全部内容,但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录;注意要先对 bin/ 的父目录使用! 规则,使其不被排除。

正文完
有偿技术支持加微信
post-qrcode
 
评论(没有评论)
验证码