GitIgnoregitignore标签03标签04标签05

引用：

说明：

  • Git提交忽略不必要的文件或文件夹

简述

对于经常使用Git的朋友来说，.gitignore配置一定不会陌生。废话不说多了，接下来就来说说这个.gitignore的使用。
首先要强调一点，这个文件的完整文件名就是”.gitignore”，注意最前面有个“.”。一般来说每个Git项目中都需要一个“.gitignore”文件，这个文件的作用就是告诉Git哪些文件不需要添加到版本管理中。实际项目中，很多文件都是不需要版本管理的。这个文件的内容是一些规则，Git会根据这些规则来判断是否将文件添加到版本控制中。

下面我们看看常用的规则：

  1. /mtk/ 过滤整个文件夹
  2. *.zip 过滤所有.zip文件
  3. /mtk/do.c 过滤某个具体文件

很简单吧，被过滤掉的文件就不会出现在git仓库中（gitlab或github）了，当然本地库中还有，只是push的时候不会上传。需要注意的是，gitignore还可以指定要将哪些文件添加到版本管理中：

  1. !*.zip
  2. !/mtk/one.txt

唯一的区别就是规则开头多了一个感叹号，Git会将满足这类规则的文件添加到版本管理中。
为什么要有两种规则呢？
想象一个场景：假如我们只需要管理/mtk/目录中的one.txt文件，这个目录中的其他文件都不需要管理，那么我们就需要使用：

  1. /mtk/
  2. !/mtk/one.txt

假设我们只有过滤规则，而没有添加规则，那么我们就需要把/mtk/目录下除了one.txt以外的所有文件都写出来！
最后需要强调的一点是，如果你不慎在创建.gitignore文件之前就push了项目，那么即使你在.gitignore文件中写入新的过滤规则，这些规则也不会起作用，Git仍然会对所有文件进行版本管理。
简单来说，出现这种问题的原因就是Git已经开始管理这些文件了，所以你无法再通过过滤规则过滤它们。因此一定要养成在项目开始就创建.gitignore文件的习惯，否则一旦push，处理起来会非常麻烦。

.gitignore配置文件用于配置不需要加入版本管理的文件，配置好该文件可以为版本管理带来很大的便利，以下是对于配置.gitignore的一些心得记录：
1）配置语法：

  • 以斜杠“/”开头表示目录；
  • 以星号“*”通配多个字符；
  • 以问号“?”通配单个字符以方括号“[]”包含单个字符的匹配列表；
  • 以叹号“!”表示不忽略(跟踪)匹配到的文件或目录；

此外，git 对于 .ignore 配置文件是按行从上到下进行规则匹配的，意味着如果前面的规则匹配的范围更大，则后面的规则将不会生效；
2）示例说明
a）规则：fd1/说明：忽略目录 fd1 下的全部内容；注意，不管是根目录下的 /fd1/ 目录，还是某个子目录 /child/fd1/ 目录，都会被忽略；—只要是fd1目录，均会被忽略；
b）规则：/fd1/说明：忽略根目录下的 /fd1/ 目录的全部内容；
c）规则：/!.gitignore!/fw/bin/!/fw/sf/说明：忽略全部内容，但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录；
*——————————————————————————————————————————————————————————————————————————————————————————————————————————————————————
下面是线上使用过的一个gerrit里项目代码的.gitignore的配置（在项目中添加.gitignore过滤文件，在git push到gerrit里即可）

  1. [wangshibo@gerrit-server hqsb_android]$ cat .gitignore
  2. #Built application files
  3. *.apk
  4. *.ap_
  6. # Files for the Dalvik VM
  7. *.dex
  9. # Java class files
  10. *.class
  12. # Generated files
  13. */bin/
  14. */gen/
  15. */out/
  17. # Gradle files
  18. .gradle/
  19. build/
  20. */build/
  21. gradlew
  22. gradlew.bat
  24. # Local configuration file (sdk path, etc)
  25. local.properties
  27. # Proguard folder generated by Eclipse
  28. proguard/
  30. # Log Files
  31. *.log
  33. # Android Studio Navigation editor temp files
  34. .navigation/
  36. # Android Studio captures folder
  37. captures/
  39. # Intellij
  40. *.iml
  41. */*.iml
  43. # Keystore files
  44. #*.jks
  45. #gradle wrapper
  46. gradle/
  48. #some local files
  49. */.settings/
  50. */.DS_Store
  51. .DS_Store
  52. */.idea/
  53. .idea/
  54. gradlew
  55. gradlew.bat
  56. unused.txt

再看一例

  1. [wangshibo@gerrit-server hqsb_ios$ cat .gitignore
  2. # Lines that start with '#' are comments.
  3. # IntelliJ IDEA Project files
  4. .idea
  5. *.iml
  6. *.ipr
  7. *.iws
  8. out
  10. # Eclipse Project files
  11. .classpath
  12. .project
  13. .settings/
  15. bin/
  16. gen/
  17. local.properties
  19. .DS_Store
  20. Thumbs.db
  22. *.bak
  23. *.tem
  24. *.temp
  25. #.swp
  26. *.*~
  27. ~*.*

———————————————————————————————————————————————方 法——————————————————————————————————————————————————————
其实，需要清除的一点是：
有三种方法可以实现过滤掉Git里不想上传的文件，这三种方法都能达到目的，只不过适用情景不一样。
1）第一种方法
针对单一工程排除文件，这种方式会让这个工程的所有修改者在克隆代码的同时，也能克隆到过滤规则，而不用自己再写一份，这就能保证所有修改者应用的都是同一份规则，而不是张三自己有一套过滤规则，李四又使用另一套过滤规则，个人比较喜欢这个。配置步骤如下：
在工程根目录下建立.gitignore文件(不一定是在工程，也可以在某个文件夹内增加，路径是相对于当前gitignore所在文件夹开始)，将要排除的文件或目录 写到.gitignore这个文件中，其中有两种写入方法。

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

  2. 最方便的办法是，用记事本打开，增加需要排除的文件或目录，一行增加一个，例如：

    1. *.class
    2. *.apk
    3. bin/
    4. gen/
    5. .settings/
    6. proguard/

    例如:
    工程文件夹下面:
    00.Git实验室--忽略篇 - 图1
    某个文件夹下:
    00.Git实验室--忽略篇 - 图2
    2）第二种方法全局设置排除文件，这会在全局起作用，只要是Git管理的工程，在提交时都会自动排除不在控制范围内的文件或目录。这种方法对开发者来说，比较省事，只要一次全局配置，不用每次建立工程都要配置一遍过滤规则。但是这不保证其他的开发者在克隆你的代码后，他们那边的规则跟你的是一样的，这就带来了代码提交过程中的各种冲突问题。配置步骤如下：

  3. 像方法（1）一样，也需要建立一个.gitignore文件，把要排除的文件写进去。

  4. 但在这里，我们不规定一定要把.gitnore文件放到某个工程下面，而是任何地方，比如我们这里放到了Git默认的Home路径下，比如：/home/wangshibo/hqsb_ios
  5. 使用命令方式可以配置全局排除文件 git config —global core.excludesfile ~/.gitignore，你会发现在~/.gitconfig文件中会出现excludesfile = /home/wangshibo/hqsb_ios/.gitignore。说明Git把文件过滤规则应用到了Global的规则中。

3）第三种方法单个工程设置排除文件，在工程目录下找到.git/info/exclude，把要排除的文件写进去：

  1. *.class
  2. *.apk
  3. bin/
  4. gen/
  5. .settings/
  6. proguard/

这种方法就不提倡了，只能针对单一工程配置，而且还不能将过滤规则同步到其他开发者，跟方法（1）（2）比较起来没有一点优势。
——————————————————————————————————Git忽略规则及.gitignore规则不生效的解决办法—————————————————————————————————————————————
在git中如果想忽略掉某个文件，不让这个文件提交到版本库中，可以使用修改根目录中 .gitignore 文件的方法（如无，则需自己手工建立此文件）。这个文件每一行保存了一个匹配的规则例如：
# 此为注释 – 将被 Git 忽略
.a # 忽略所有 .a 结尾的文件
!lib.a # 但 lib.a 除外
/TODO # 仅仅忽略项目根目录下的 TODO
文件，不包括 subdir/TODObuild/ # 忽略 build/ 目录下的所有文件doc/.txt # 会忽略 doc/notes.txt 但不包括 doc/server/arch.txt

规则很简单，不做过多解释，但是有时候在项目开发过程中，突然心血来潮想把某些目录或文件加入忽略规则，按照上述方法定义后发现并未生效，原因是.gitignore只能忽略那些原来没有被track的文件，如果某些文件已经被纳入了版本管理中，则修改.gitignore是无效的。那么解决方法就是先把本地缓存删除（改变成未track状态），然后再提交：

  1. git rm -r --cached .
  2. git add .
  3. git commit -m 'update .gitignore'

注意：不要误解了 .gitignore 文件的用途，该文件只能作用于 Untracked Files，也就是那些从来没有被 Git 记录过的文件（自添加以后，从未 add 及 commit 过的文件）。
【当你用心写完每一篇博客之后,你会发现它比你用代码实现功能更有成就感!】

  • 本文作者：GeekPower - Felix Sun
  • 版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！