如何创建.gitignore文件,忽略git不必要提交的文件

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了如何创建.gitignore文件,忽略git不必要提交的文件相关的知识,希望对你有一定的参考价值。

在Git的使用过程中,有很多文件是不需要被提交到版本管理的,比如mac的朋友都知道.DS_Store 文件在每个文件夹中都会出现,但是这个文件对代码同步来说并没有什么作用,所以我们需要把这个文件排除在b岸本管理之外,这个时候就需要我们问答的 gitignore文件来搞定了。
首先声明我的使用环境为mac,所以windows使用起来有更简单的方法,或者有些命令windows不能使用
默认情况之下gitignore文件是不存在的,我们需要把这个文件新建一下,在终端中你首先cd到你的工程目录下,然后输入命令
touch .gitignore 1

这样你就可以在文件中新增一个.gitignore隐藏文件。
可以使用
ls -all 或者linux下使用 ll1

进行查看,之后对文件进行编辑
vi .gitignore 1

在vi中使用 i 命令对文件进行编辑,然后点击esc 使用 :wq命令进行保存
1、配置语法:
以斜杠“/”开头表示目录;
以星号“*”通配多个字符;
以问号“?”通配单个字符
以方括号“[]”包含单个字符的匹配列表;
以叹号“!”表示不忽略(跟踪)匹配到的文件或目录;
此外,git 对于 .ignore 配置文件是按行从上到下进行规则匹配的,意味着如果前面的规则匹配的范围更大,则后面的规则将不会生效;
2、示例:
(1)规则:fd1/*
说明:忽略目录 fd1 下的全部内容;注意,不管是根目录下的 /fd1/ 目录,还是某个子目录 /child/fd1/ 目录,都会被忽略;
(2)规则:/fd1/*
说明:忽略根目录下的 /fd1/ 目录的全部内容;
(3)规则:
/*
!.gitignore
!/fw/bin/
!/fw/sf/

说明:忽略全部内容,但是不忽略 .gitignore 文件、根目录下的 /fw/bin/ 和 /fw/sf/ 目录;
例如我配置的是
launchConfigurations/
.DS_Store
test.txt123

之后提交到远端就可以了
但是如果你需要忽略的文件意境存在在远端中了,那么你需要将远端中的文件删除掉才可以:
使用git rm --cached .DS_Store进行删除
git rm –cached 把文件.DS_Store从git的索引库中移除,但是对文件.DS_Store本身并不进行任何操作也就是说本地还是有.DS_Store文件的,但是远端却没有了
之后再使用git commit /push 之后提交上去
这样就不会再用担心这个文件的冲突了
参考技术A 1、.gitignore:
在工程实现过程中,会生成一些中间文件,或者在项目中的部分文件是不需要进行版本管理的。对于这些文件应该对于Github来讲是透明的。Github提供这种功能,可以自己指定哪些文件可以不被管理。具体方法是在版本管理的根目录下(与.git文件夹同级)创建一个 .gitignore(gitignore是隐藏文件,所以前面有个点)
gitignore - Specifies intentionally untracked files to ignore
2、使用gitignore文件来解决这个问题,步骤是:
1) touch .gitignore #创建gitignore隐藏文件
2) vim .gitignore #编辑文件,加入指定文件
#下面是gitignore文件的内容
#忽略gitignore文件
.gitignore
#忽略后缀名为.o和.a的文件
*.[oa]
#显示指定忽略名称为main的文件
main
3、文件.gitignore的格式规范:
A:#为注释
B:可以使用shell所使用的正则表达式来进行模式匹配
C:匹配模式最后跟"/"说明要忽略的是目录
D:使用!取反(例如目录中包含 test.a,并且gitignore文件中包含 *.[oa],如果在文件中加入 !test.a 表明忽略除test.a文件以外的后缀名为.a或者.o的文件)
4、配置完.gitignore文件后,执行git status命令,会发现那些文件不再是Untracked files了,也就完成了忽略指定文件的功能。

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

        对于经常使用Git的朋友来说,.gitignore配置一定不会陌生,文件的完整文件名就是".gitignore",注意最前面有个“.”,创建的方法是打开记事本另存为.gitignore, 一般来说每个Git项目中都需要一个“.gitignore”文件,这个文件的作用就是告诉Git哪些文件不需要添加到版本管理中。

常用的规则:
1)/bin/                                        过滤整个文件夹
2)*.zip                                        过滤所有.zip文件
3)/bin/doc/help.doc                    过滤某个具体文件

        被过滤掉的文件就不会出现在git仓库中(gitlab或github)了,当然本地库中还有,只是push的时候不会上传。如果初次上传时就添加到了.gitignore中,代码仓中也没有了
需要注意的是,gitignore还可以指定要将哪些文件添加到版本管理中:
1)!*.zip
2)!/bin/doc/help.doc

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

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

        有三种方法可以实现过滤掉Git里不想上传的文件,这三种方法都能达到目的,只不过适用情景不一样,第一种和第二种可以将规则同步到其他开发者,第三种方法不能将过滤规则同步到其他开发者。

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

        在工程根目录下建立.gitignore文件(不一定是在工程,也可以在某个文件夹内增加,路径是相对于当前gitignore所在文件夹开始),将要排除的文件或目录 写到.gitignore这个文件中。

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

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

以上是关于如何创建.gitignore文件,忽略git不必要提交的文件的主要内容,如果未能解决你的问题,请参考以下文章

如何创建.gitignore文件,忽略不必要提交的文件

如何创建.gitignore文件,忽略git不必要提交的文件

如何创建.gitignore文件,忽略git不必要提交的文件

如何创建.gitignore文件,忽略git不必要提交的文件

IDEA创建.gitignore文件模板忽略git提交.idea等文件

git使用.gitignore忽略提交文件并没有生效问题解决