Git 忽略提交规则及运用

在使用 Git 的过程中,我们喜欢有的文件比如日志,临时文件,编译的中间文件等不要提交到代码仓库,这时就要设置相应的忽略规则,来忽略这些文件的提交。简单来说一个场景:在你使用 git add . 的时候,遇到了把你不想提交的文件也添加到了缓存中去的情况,比如项目的本地配置信息,如果你上传到 Git 中去其他人 pull 下来的时候就会和他本地的配置有冲突,所以这样的个性化配置文件我们一般不把它推送到 git 服务器中,但是又为了偷懒每次添加缓存的时候都想用 git add . 而不是手动一个一个文件添加,该怎么办呢?很简单,git 为我们提供了一个.gitignore 文件只要在这个文件中申明那些文件你不希望添加到 git 中去,这样当你使用 git add . 的时候这些文件就会被自动忽略掉。有三种方法可以实现忽略 Git 中不想提交的文件:

1 在 Git 项目中定义.gitignore 文件#

对于经常使用 Git 的朋友来说,.gitignore 配置一定不会陌生。这种方式通过在项目的某个文件夹下定义.gitignore 文件,在该文件中定义相应的忽略规则,来管理当前文件夹下的文件的 Git 提交行为。.gitignore 文件是可以提交到公有仓库中,这就为该项目下的所有开发者都共享一套定义好的忽略规则。在.gitingore 文件中,遵循相应的语法,在每一行指定一个忽略规则。如:

*.log
*.temp
/vendor

2 在 Git 项目的设置中指定排除文件#

这种方式只是临时指定该项目的行为,需要编辑当前项目下的 .git/info/exclude 文件,然后将需要忽略提交的文件写入其中。需要注意的是,这种方式指定的忽略文件的根目录是项目根目录。

3 定义 Git 全局的 .gitignore 文件#

除了可以在项目中定义 .gitignore 文件外,还可以设置全局的 git .gitignore 文件来管理所有 Git 项目的行为。这种方式在不同的项目开发者之间是不共享的,是属于项目之上 Git 应用级别的行为。这种方式也需要创建相应的 .gitignore 文件,可以放在任意位置。然后在使用以下命令配置 Git:

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

首先要强调一点,这个文件的完整文件名就是”.gitignore”,注意最前面有个 “.”。一般来说每个 Git 项目中都需要一个 “.gitignore” 文件,这个文件的作用就是告诉 Git 哪些文件不需要添加到版本管理中。实际项目中,很多文件都是不需要版本管理的,比如 Python 的.pyc 文件和一些包含密码的配置文件等等。这个文件的内容是一些规则,Git 会根据这些规则来判断是否将文件添加到版本控制中。Git 忽略文件的原则:

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

4 .gitignore 文件的使用方法#

首先,在你的工作区新建一个名称为.gitignore 的文件。
然后,把要忽略的文件名填进去,Git 就会自动忽略这些文件。
不需要从头写.gitignore 文件,GitHub 已经为我们准备了各种配置文件,只需要组合一下就可以使用了。

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

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

.gitignore 注释用’#’, * 表示匹配 0 个或多个任意字符,所以上面的模式就是要忽略所有的 xml 文件,log 文件和 apk 文件。
.gitignore 配置文件用于配置不需要加入版本管理的文件,配置好该文件可以为版本管理带来很大的便利。

5 .gitignore 忽略规则的优先级#

在 .gitingore 文件中,每一行指定一个忽略规则,Git 检查忽略规则的时候有多个来源,它的优先级如下(由高到低):
1)从命令行中读取可用的忽略规则
2)当前目录定义的规则
3)父级目录定义的规则,依次递推
4)$GIT_DIR/info/exclude 文件中定义的规则
5)core.excludesfile 中定义的全局规则

6 .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 配置文件是按行从上到下进行规则匹配的,意味着如果前面的规则匹配的范围更大,则后面的规则将不会生效;

7 .gitignore 忽略规则简单说明#

#表示此为注释,将被Git忽略
#
#表示忽略所有 .a 结尾的文件
*.a
#表示但lib.a除外
!lib.a
#表示仅仅忽略项目根目录下的 TODO 文件,不包括 subdir/TODO
/TODO 
#表示忽略 build/目录下的所有文件,过滤整个build文件夹;
build/ 
#表示会忽略doc/notes.txt但不包括 doc/server/arch.txt
doc/*.txt
#表示忽略当前路径下的bin文件夹,该文件夹下的所有内容都会被忽略,不忽略 bin 文件
bin/:
#表示忽略根目录下的bin文件
/bin:
#表示忽略cat.c,不忽略 build/cat.c
/*.c:
#表示忽略debug/io.obj,不忽略 debug/common/io.obj和tools/debug/io.obj
debug/*.obj: 
#表示忽略/foo,a/foo,a/b/foo等
**/foo:  
#表示忽略a/b, a/x/b,a/x/y/b等
a/**/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/的父目录使用!规则,使其不被排除。

温馨提示:#

如果你不慎在创建.gitignore 文件之前就 push 了项目,那么即使你在.gitignore 文件中写入新的过滤规则,这些规则也不会起作用,Git 仍然会对所有文件进行版本管理。简单来说出现这种问题的原因就是 Git 已经开始管理这些文件了,所以你无法再通过过滤规则过滤它们。所以大家一定要养成在项目开始就创建.gitignore 文件的习惯,否则一单 push,处理起来会非常麻烦。

8 .gitignore 忽略规则常用示例#

示例 1#

比如你的项目是 java 项目,.java 文件编译后会生成.class 文件,这些文件多数情况下是不想被传到仓库中的文件。这时候你可以直接适用 github 的.gitignore 文件模板。github.com/github/gitignore/blob/m... 将这些忽略文件信息复制到你的.gitignore 文件中去:

# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
  • 可以看到 github 为我们提供了最流行的.gitignore 文件配置。保存.ignore 文件后我们查看下 git status,检查下是否还有我们不需要的文件会被添加到 git 中去:

    $ git status
    On branch master
    Initial commit
    Changes to be committed:
    (use "git rm --cached <file>..." to unstage)
          new file:   .gitignore
          new file:   HelloWorld.java
    Untracked files:
    (use "git add <file>..." to include in what will be committed)
          Config.ini
  • 比如我的项目目录下有一个 Config.ini 文件,这个是个本地配置文件我不希望上传到 git 中去,我们可以在 gitignore 文件中添加这样的配置: Config.ini

  • 或者你想忽略所有的.ini 文件你可以这样写:*.ini

  • 如果有些文件已经被你忽略了,当你使用 git add 时是无法添加的,比如我忽略了 *.class,现在我想把 HelloWorld.class 添加到 git 中去:

$ git add HelloWorld.class
The following paths are ignored by one of your .gitignore files:
HelloWorld.class
Use -f if you really want to add them.
  • git 会提示我们这个文件已经被我们忽略了,需要加上 - f 参数才能强制添加到 git 中去:

    $ git status
    On branch master
    Initial commit
    Changes to be committed:
    (use "git rm --cached <file>..." to unstage)
          new file:   .gitignore
          new file:   HelloWorld.class
          new file:   HelloWorld.java
  • 这样就能强制添加到缓存中去了。如果我们意外的将想要忽略的文件添加到缓存中去了,我们可以使用 rm 命令将其从中移除:

$ git rm HelloWorld.class --cached
rm 'HelloWorld.class'
  • 如果你已经把不想上传的文件上传到了 git 仓库,那么你必须先从远程仓库删了它,我们可以从远程仓库直接删除然后 pull 代码到本地仓库这些文件就会本删除,或者从本地删除这些文件并且在.gitignore 文件中添加这些你想忽略的文件,然后再 push 到远程仓库。

示例 2#

#下面是曾经线上使用过的一个gerrit里项目代码的.gitignore的配置(在项目中添加.gitignore过滤文件,在git push到gerrit里即可)
[wangshibo@gerrit-server hq_ios]$ cat .gitignore
#Built application files
*.apk
*.ap_

# Files for the Dalvik VM
*.dex

# Java class files
*.class

# Generated files
*/bin/
*/gen/
*/out/

# Gradle files
.gradle/
build/
*/build/
gradlew
gradlew.bat

# Local configuration file (sdk path, etc)
local.properties

# Proguard folder generated by Eclipse
proguard/

# Log Files
*.log

# Android Studio Navigation editor temp files
.navigation/

# Android Studio captures folder
captures/

# Intellij
*.iml
*/*.iml

# Keystore files
#*.jks
#gradle wrapper
gradle/

#some local files
*/.settings/
*/.DS_Store
.DS_Store
*/.idea/
.idea/
gradlew
gradlew.bat
unused.txt

示例 3#

[wangshibo@gerrit-server hq_ios$ cat .gitignore
# Lines that start with '#' are comments.
# IntelliJ IDEA Project files
.idea
*.iml
*.ipr
*.iws
out

# Eclipse Project files
.classpath
.project
.settings/

bin/
gen/
local.properties

.DS_Store
Thumbs.db

*.bak
*.tem
*.temp
#.swp
*.*~
~*.*

9 .gitignor 忽略规则查看#

  • 如果你发下.gitignore 写得有问题,需要找出来到底哪个规则写错了,可以用 git check-ignore 命令检查:

    $ git check-ignore -v HelloWorld.class
    .gitignore*.class    HelloWorld.class
  • 可以看到 HelloWorld.class 匹配到了我们的第一条 *.class 的忽略规则所以文件被忽略了。

  • 简单来说,要实现过滤掉 Git 里不想上传的文件,如上介绍三种方法能达到这种目的,只不过适用情景不一样:

============第一种方法===========
#针对单一工程排除文件,这种方式会让这个工程的所有修改者在克隆代码的同时,也能克隆到过滤规则,而不用自己再写一份,
#这就能保证所有修改者应用的都是同一份规则,而不是张三自己有一套过滤规则,李四又使用另一套过滤规则,个人比较喜欢这个。

#配置步骤如下:
#在工程根目录下建立.gitignore文件,将要排除的文件或目录 写到.gitignore这个文件中,其中有两种写入方法:

#a)使用命令行增加排除文件
#排除以.class结尾的文件 echo "*.class" >.gitignore (>> 是在文件尾增加,> 是删除已经存在的内容再增加),之后会在当前目录下
#生成一个.gitignore的文件。排除bin目录下的文件 echo "bin/" >.gitignore

#b)最方便的办法是,用记事本打开,增加需要排除的文件或目录,一行增加一个,例如:
*.class
*.apk
bin/
gen/
.settings/
proguard/


===========第二种方法===========
#全局设置排除文件,这会在全局起作用,只要是Git管理的工程,在提交时都会自动排除不在控制范围内的文件或目录。这种方法对开发者来说,
#比较省事,只要一次全局配置,不用每次建立工程都要配置一遍过滤规则。但是这不保证其他的开发者在克隆你的代码后,他们那边的规则跟你
#的是一样的,这就带来了代码提交过程中的各种冲突问题。
#配置步骤如下:
#a)像方法(1)一样,也需要建立一个.gitignore文件,把要排除的文件写进去。
#b)但在这里,我们不规定一定要把.gitnore文件放到某个工程下面,而是任何地方,比如我们这里放到了Git默认的Home路径下,比如:/home/wangshibo/hqsb_ios
#c)使用命令方式可以配置全局排除文件:
   # git config --global core.excludesfile ~/.gitignore
  # 你会发现在~/.gitconfig文件中会出现excludesfile = /home/wangshibo/hqsb_ios/.gitignore。
   #说明Git把文件过滤规则应用到了Global的规则中。


===========第三种方法===========
#单个工程设置排除文件,在工程目录下找到.git/info/exclude,把要排除的文件写进去:
*.class
*.apk
bin/
gen/
.settings/
proguard/
#这种方法就不提倡了,只能针对单一工程配置,而且还不能将过滤规则同步到其他开发者,跟方法一和方法二比较起来没有一点优势。

10 Git 忽略规则 (.gitignore 配置)不生效原因和解决#

#第一种方法:
#.gitignore中已经标明忽略的文件目录下的文件,git push的时候还会出现在push的目录中,或者用git status查看状态,想要忽略的文件还是显示被追踪状态。
#原因是因为在git忽略目录中,新建的文件在git中会有缓存,如果某些文件已经被纳入了版本管理中,就算是在.gitignore中已经声明了忽略路径也是不起作用的,
#这时候我们就应该先把本地缓存删除,然后再进行git的提交,这样就不会出现忽略的文件了。

#解决方法: git清除本地缓存(改变成未track状态),然后再提交:
[root@kevin ~]# git rm -r --cached .
[root@kevin ~]# git add .
[root@kevin ~]# git commit -m 'update .gitignore'
[root@kevin ~]# git push -u origin master

#需要特别注意的是:
#1).gitignore只能忽略那些原来没有被track的文件,如果某些文件已经被纳入了版本管理中,则修改.gitignore是无效的。
#2)想要.gitignore起作用,必须要在这些文件不在暂存区中才可以,.gitignore文件只是忽略没有被staged(cached)文件,
#   对于已经被staged文件,加入ignore文件时一定要先从staged移除,才可以忽略。

#第二种方法:(推荐)
#在每个clone下来的仓库中手动设置不要检查特定文件的更改情况。
[root@kevin ~]# git update-index --assume-unchanged PATH                  //在PATH处输入要忽略的文件

11 在使用.gitignore 文件后如何删除远程仓库中以前上传的此类文件而保留本地文件#

在使用git和github的时候,之前没有写.gitignore文件,就上传了一些没有必要的文件,在添加了.gitignore文件后,就想删除远程仓库中的文件却想保存本地的文件。这时候不可以直接使用"git rm directory",这样会删除本地仓库的文件。可以使用"git rm -r –cached directory"来删除缓冲,然后进行"commit""push",这样会发现远程仓库中的不必要文件就被删除了,以后可以直接使用"git add -A"来添加修改的内容,上传的文件就会受到.gitignore文件的内容约束。额外说明:git库所在的文件夹中的文件大致有4种状态 
Untracked:
未跟踪, 此文件在文件夹中, 但并没有加入到git库, 不参与版本控制. 通过git add 状态变为Staged.

Unmodify:
文件已经入库, 未修改, 即版本库中的文件快照内容与文件夹中完全一致. 这种类型的文件有两种去处, 如果它被修改,
而变为Modified. 如果使用git rm移出版本库, 则成为Untracked文件

Modified:
文件已修改, 仅仅是修改, 并没有进行其他的操作. 这个文件也有两个去处, 通过git add可进入暂存staged状态,
使用git checkout 则丢弃修改过, 返回到unmodify状态, 这个git checkout即从库中取出文件, 覆盖当前修改

Staged:
暂存状态. 执行git commit则将修改同步到库中, 这时库中的文件和本地文件又变为一致, 文件为Unmodify状态.
执行git reset HEAD filename取消暂存, 文件状态为Modified

Git 状态 untracked 和 not staged的区别
1)untrack     表示是新文件,没有被add过,是为跟踪的意思。
2)not staged  表示add过的文件,即跟踪文件,再次修改没有add,就是没有暂存的意思
本作品采用《CC 协议》,转载必须注明作者和本文链接