.gitignore 文件的说明文档

今天有同事问我这个问题,我寻思着网上有很多资料可以查看了,写的也都非常好。
她说就得看我写的,做一个简单记录:

.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 文件覆盖。

相关推荐

  1. .gitignore 文件说明文档

    2024-05-14 04:36:02       11 阅读
  2. .gitignore文件使用

    2024-05-14 04:36:02       25 阅读
  3. 关于.gitignore文件

    2024-05-14 04:36:02       34 阅读
  4. 如何编写.gitignore文件

    2024-05-14 04:36:02       28 阅读
  5. HTML文档说明

    2024-05-14 04:36:02       13 阅读
  6. 解决.gitignore文件无效问题

    2024-05-14 04:36:02       38 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-05-14 04:36:02       16 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-05-14 04:36:02       16 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-05-14 04:36:02       15 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-05-14 04:36:02       18 阅读

热门阅读

  1. day5 qt

    day5 qt

    2024-05-14 04:36:02      14 阅读
  2. 重构四要素:目的、对象、时机和方法

    2024-05-14 04:36:02       14 阅读
  3. c++ 读写锁简单试验

    2024-05-14 04:36:02       11 阅读
  4. 数学符号大全

    2024-05-14 04:36:02       14 阅读
  5. 几种ssh自动登录服务器的方法

    2024-05-14 04:36:02       9 阅读
  6. Linux系统日志每日备份脚本

    2024-05-14 04:36:02       9 阅读
  7. getter和setter方法的优缺点

    2024-05-14 04:36:02       12 阅读
  8. leetcode 918.环形子数组的最大和

    2024-05-14 04:36:02       10 阅读
  9. JanusGraph Tinkerpop

    2024-05-14 04:36:02       8 阅读
  10. 船舶检测数据集VOC+YOLO格式7000张6类别

    2024-05-14 04:36:02       11 阅读