【亲测免费】 BFGRepo-Cleaner安装与配置完全指南

项目基础介绍

BFG Repo-Cleaner，由Scala编写的高效Git仓库清理工具，专为快速移除大型文件或麻烦的blobs设计，性能远超git-filter-branch。这款开源工具是应对Git仓库中不慎提交的大文件（如超出常规的源代码文件、日志文件或是私密数据）的理想选择。它简化了清理过程，帮助开发者保持仓库的轻量化和安全。项目托管在GitHub，地址为 rtyley/bfg-repo-cleaner，并遵循GPL-3.0许可协议。

关键技术和框架

• 核心语言: Scala
• 目标: 高效处理Git仓库中的大文件及敏感数据，提供比git-filter-branch更快的解决方案。
• 关键技术点:
  • 快速扫描Git历史记录来识别大文件或特定模式的文件。
  • 安全地从已推送到远程的仓库历史中移除文件而不会破坏SHA完整性。
  • 支持通过正则表达式替换文本，比如密码或凭证信息。

准备工作与安装步骤

环境要求

• Java环境: BFG Repo-Cleaner需要JRE 1.7或更高版本。你可以通过运行java -version命令来检查是否已安装Java及其版本。
• Git: 确保你的系统上安装了Git，并可通过命令行访问。

步骤一：下载BFG Repo-Cleaner

由于BFG是以可执行jar的形式发布的，你可以直接从其GitHub发布页面下载最新的jar文件，或者通过curl命令直接下载到本地：

curl -L https://repo.maven.apache.org/maven2/com/madgag/scalasti/bfg/1.14.0/bfg-1.14.0.jar -o bfg.jar

步骤二：配置与使用

1. 备份你的仓库：在运行BFG之前，强烈建议对你的Git仓库进行完整备份，以防意外发生。

2. 运行BFG：假设你的仓库路径为my-git-repo.git，要删除所有大于1MB的文件，可以使用以下命令：

   java -jar bfg.jar --strip-blobs-bigger-than 1M my-git-repo.git
   

   若需替换文本（例如，删除或替换敏感数据），使用如下命令：

   java -jar bfg.jar --replace-text banned.txt --no-blob-protection my-git-repo.git
   

   其中，banned.txt包含了你想要被替换或删除的字符串列表。

3. 强制推送更新：清理后，你需要清空本地的Git缓存，并将修改后的历史推送到远程仓库。首先，进入你的Git仓库目录，并执行：

   cd my-git-repo.git
   git reflog expire --expire=now --all && \
   git gc --prune=now --aggressive
   

   接着，使用--force选项推送更改至远程仓库（这一步会覆盖远程的历史记录，因此务必小心）：

   git push origin --force --all
   git push origin --force --tags
   

步骤三：注意事项

• 使用BFG进行操作前，确保理解其可能带来的影响，尤其是当你有合并过的分支时。
• 在执行任何强制推送之前通知团队成员，以避免造成他们的困扰或丢失工作。

通过以上步骤，即使是初学者也能顺利完成BFG Repo-Cleaner的安装和使用，有效管理你的Git仓库，使其更加整洁和安全。