BFG 移除 Git仓库中大文件和隐私文件

准备条件

• [下载 BFG工具] (https://rtyley.github.io/bfg-repo-cleaner/)
• 安装 java 运行环境

使用方法

• 下载官网的程序包。例如我这里下载的为bfg-1.13.0.jar，之后将程序包放到一个文件夹里.注意：bfg-1.13.0.jar改名为bfg

• 克隆仓库的 git repo,使用--mirror参数，克隆完成后，example.git 和 bfg 放到一个文件中

  git clone --mirror https://github.com/example.git
  

• 清除大文件，文件夹，隐私文件

  • 这里官网给出的命令是这样的。第一句是删除文件，第二句是删除文件夹，两个语句的区别在附加参数上。这里，不指定文件/文件夹位置，只是用名称匹配。

    java -jar bfg.jar --delete-files [文件名称] example.git  
    java -jar bfg.jar --delete-folders [文件夹名称] example.git
    

  • 这样会有一个问题，这种情况bfg会保护当前版本(HEAD所指的版本)，不去清理。提示如下:

    Protected commits
    -----------------
    These are your protected commits, and so their contents will NOT be altered:
    
     * commit ******* (protected by 'HEAD')
     
    

  • 在命令行下加入--no-blob-protection命令，可以解除保护。我使用的命令如下。

    java -jar bfg.jar --delete-files libBaiduSpeechSDK.a example.git  --no-blob-protection
    java -jar bfg.jar --delete-folders TTS example.git --no-blob-protection
    

• 清理不需要的数据

  • 在完成上面的指令后，实际上这些数据/文件并没有被直接删除，这时候需要使用git gc指令来清除

    cd example.git
    git reflog expire --expire=now --all && git gc --prune=now --aggressive
    

• 推送到GitHub

  • 将数据推送到GitHub远程仓库。按照官网描述，由于之前使用了--mirror参数，推送时会推送所有内容。

    git push