.gitignore 文件的说明文档

其他   2024-05-13 16:06   140   0  

.gitignore 文件用于在 Git 版本控制系统中指定不需要跟踪的文件和目录

1、确定要忽略的文件和目录:

生成的文件:如 .class、.jar、.o、.pyc 等。

敏感信息:如密码、API 密钥、访问令牌等。

用户特定文件:如本地配置、缓存等。

构建产物和输出:如 /bin、/build、/dist、/target 等目录。

第三方库和依赖项(通常通过包管理器管理)。

2、创建 .gitignore 文件:

在项目的根目录下创建一个名为 .gitignore 的文件(注意前面的点号)。

3、编写规则:

每行表示一个模式,用于匹配要忽略的文件或目录。

使用通配符和正则表达式来定义模式。

eg:

*.log 忽略所有 .log 文件。

bin/ 忽略 bin/ 目录及其所有内容。

/temp-* 忽略根目录下所有以 temp- 开头的文件。

!dir/important.file 不忽略 dir/ 目录下的 important.file 文件(即使其上级目录被忽略)。

4、测试规则:

在将 .gitignore 文件添加到版本控制并提交之前,确保它按预期工作。

使用 git status 命令来查看 Git 是否跟踪不希望跟踪的文件。

5、提交 .gitignore 文件:

将 .gitignore 文件添加到版本控制并提交。这样,其他开发者也可以从仓库中获取相同的忽略规则。

注意:

如果文件已经被 Git 跟踪(即已经提交到仓库),则 .gitignore 文件对其无效。需要先从 Git 中删除这些文件(使用 git rm --cached 命令),然后提交更改。

.gitignore 文件也可以包含注释,以 # 开头的行将被视为注释。

可以使用模板或在线资源来生成 .gitignore 文件,这些资源通常包含针对各种编程语言和框架的常见忽略规则。

6、全局 .gitignore:

如果希望为所有 Git 仓库设置全局的忽略规则,可以在用户主目录下创建一个名为 .gitignore_global 的文件(或其他你喜欢的名称),并在其中定义规则。然后,使用 git config --global core.excludesfile ~/.gitignore_global 命令将其设置为全局忽略文件。这样,无论在哪个仓库工作,这些全局规则都会生效。但请注意,全局规则可能会被项目级的 .gitignore 文件覆盖。


博客评论
还没有人评论,赶紧抢个沙发~
发表评论
说明:请文明发言,共建和谐网络,您的个人信息不会被公开显示。
闲言碎语
如果你很忙,除了你真的很重要以外,更可能的原因是:你很弱,你没有什么更好的事情去做,你生活太差不得不努力来弥补,或者你装作很忙,让自己显得很重要。
赞赏支持

如果觉得博客文章对您有帮助,异或土豪有钱任性,可以通过以下扫码向我捐助。也可以动动手指,帮我分享和传播。您的肯定,是我不懈努力的动力!感谢各位亲~