Github学习(2)——gitignore的设置

这两天在项目组协作的时候碰到了一些问题,主要是不同系统电脑不同编译器编译产生的文件不同导致在pull以后会产生报错,还有就是不同系统生成的路径记录,比如MacOS下的.DS_Store文件,每次对项目稍作修改都会导致这个文件产生变化,需要重新pull。
查了一些资料发现可以通过设置.gitignore文件来规定Git在pull过程中会忽略哪些文件。
首先要强调一点,这个文件的完整文件名就是”.gitignore”,注意最前面有个“.”。
一般来说每个Git项目中都需要一个“.gitignore”文件,这个文件的作用就是告诉Git哪些文件不需要添加到版本管理中。实际项目中,很多文件都是不需要版本管理的,比如Python的.pyc文件和一些包含密码的配置文件等等。这个文件的内容是一些规则,Git会根据这些规则来判断是否将文件添加到版本控制中。

配置语法:

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

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

示例说明

  1. 规则:fd1/*
    说明:忽略目录 fd1 下的全部内容;注意,不管是根目录下的 /fd1/ 目录,还是某个子目录 /child/fd1/ 目录,都会被忽略;
  2. 规则:/fd1/*
    说明:忽略根目录下的 /fd1/ 目录的全部内容;
  3. 规则:
    /*
    !.gitignore
    !/fw/bin/
    !/fw/sf/
    说明:忽略全部内容,但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录;

配置方法

有两种方法可以实现过滤掉Git里不想上传的文件,这两种方法都能达到目的,只不过适用情景不一样。

  1. 第一种方法
    针对单一工程排除文件,这种方式会让这个工程的所有修改者在克隆代码的同时,也能克隆到过滤规则,而不用自己再写一份,这就能保证所有修改者应用的都是同一份规则,而不是张三自己有一套过滤规则,李四又使用另一套过滤规则,个人比较喜欢这个。配置步骤如下:
    在工程根目录下建立.gitignore文件,将要排除的文件或目录 写到.gitignore这个文件中,其中有两种写入方法。

    • 使用命令行增加排除文件
      排除以.class结尾的文件 echo “*.class” >.gitignore (>> 是在文件尾增加,> 是删除已经存在的内容再增加),之后会在当前目录下生成一个.gitignore的文件。
      排除bin目录下的文件 echo “bin/” >.gitignore
    • 最方便的办法是,用记事本打开,增加需要排除的文件或目录,一行增加一个,例如:

    *.class
    *.apk
    bin/
    gen/
    .settings/
    proguard/

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

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

注意:

不要误解了 .gitignore 文件的用途,该文件只能作用于 Untracked Files,也就是那些从来没有被 Git 记录过的文件(自添加以后,从未 add 及 commit 过的文件)。
如果文件曾经被 Git 记录过,那么.gitignore 就对它们完全无效。

添加.gitignore文件前后对比:
before_gitignore
after_gitignore

在我的项目中由于是多人协作进行开发,为了方便使用了第一种配置方法,但仍然感觉每个Repository都需要手动配置还是有点麻烦,然后仔细研究了一下发现其实在Github Desktop新建Repository的时候就可以根据项目所用语言预设.gitignore文件
Create a new Repository
Git Ignore
如图所示设置Git Ignore后就会在工程根目录自动生成适用于所选语言的.gitignore文件,于是就把Repository删了重新建了一个(╯°□°)╯︵┻━┻

参考资料:Git忽略规则.gitignore梳理
Git之忽略文件(ignore file)

猜你喜欢

转载自blog.csdn.net/angus_monroe/article/details/78720061