BFG Repo-Cleaner 开源项目指南及问题解答

BFG Repo-Cleaner 开源项目指南及问题解答

bfg-repo-cleaner Removes large or troublesome blobs like git-filter-branch does, but faster. And written in Scala 项目地址: https://gitcode.com/gh_mirrors/bf/bfg-repo-cleaner

项目基础介绍

BFG Repo-Cleaner 是一个高效且强大的Git仓库清理工具，由Scala语言编写而成。它设计用于快速移除仓库中的大型文件或棘手的数据块，其速度远超传统的git-filter-branch命令，并且提供了更为简洁的操作界面。通过该工具，开发者可以轻松地从他们的Git历史记录中删除不需要的大文件，比如偶然提交的密码文件、大型日志文件或者测试数据等，从而优化仓库大小和提高效率。

新手指引：需特别注意的问题与解决步骤

问题1：如何处理已提交的大文件

解决步骤：

1. 安装BFG: 确保你的系统中已安装Java，然后可以通过下载BFG jar文件来安装它。命令行执行：

   wget https://repo1.maven.org/maven2/com/madgag/bfg/1.14.0/bfg-1.14.0.jar
   

2. 运行BFG: 进入到你的仓库根目录，然后运行类似以下的命令，以移除所有大于1MB的文件：

   java -jar bfg-1.14.0.jar --strip-blobs-bigger-than 1M --replace-text banned.txt .
   

   注意替换banned.txt为你存储敏感词或文件名的列表（如果有的话）。

3. 强制推送更新: 清理后，你需要使用git reflog expire --expire=now --all和git gc --prune=now优化本地仓库，最后进行强制推送更新到远程仓库（小心操作，这将覆盖远程历史）：

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

问题2：避免将来不小心再次提交大文件

解决步骤：

1. 配置Git钩子防止大文件提交：利用.git/hooks/pre-commit脚本检查即将提交的文件大小。

   在仓库的.git/hooks目录下创建一个pre-commit文件，并添加以下内容：

   #!/bin/sh
   git diff-index --cached --name-only HEAD | xargs du -h | awk '{ if ($1 > "1M") print }'
   

   别忘了给此脚本执行权限：chmod +x .git/hooks/pre-commit。

2. 使用.gitignore文件管理不希望被提交的文件类型或特定文件。

问题3：遇到“权限不足”错误

解决步骤：

如果你在运行BFG时遇到权限问题，确保你有足够的权限去修改你的Git仓库。如果是在Windows上，尝试以管理员模式打开命令提示符执行相关命令。在Linux或macOS中，使用sudo（尽管通常是不必要的，因为推荐直接在仓库目录拥有所有权）。

通过遵循以上步骤，新手可以更加自信并有效地使用BFG Repo-Cleaner，确保他们的Git仓库既健康又安全。记得在操作之前备份你的仓库，以防万一。

bfg-repo-cleaner Removes large or troublesome blobs like git-filter-branch does, but faster. And written in Scala 项目地址: https://gitcode.com/gh_mirrors/bf/bfg-repo-cleaner