删除Git历史中的文件

​git filter-repo 或 git filter-branch 是解决这种问题的常见方法。当你将 .env 文件意外提交到 Git 历史记录中，之后又通过 .gitignore 忽略它时，虽然新提交不会包含它，但它仍然存在于历史提交中。为了彻底从 Git 历史记录中删除敏感信息（如 .env 文件，其中可能包含API密钥或数据库凭证），你需要重写仓库的历史记录。

这是一个需要谨慎操作的过程，因为它会更改你的项目的提交历史。在执行任何步骤之前，请务必备份你的仓库。

核心概念：重写历史

Git 的历史记录是不可变的。要“删除”文件，你实际上需要创建一系列新的提交，这些新提交在任何时间点都不包含.env 文件。

推荐方法：使用 git filter-repo​

​git filter-repo 是 git filter-branch 的一个更现代、更快速、更安全的替代品，由 Git 社区推荐。

1. 安装 git filter-repo​

如果你还没有安装它，可以通过 pip 安装（Python 3.5 以上）：

• macOS / Linux (使用 Homebrew):

    brew install git-filter-repo

• Python (推荐，跨平台):

  pip install git-filter-repo
  

  或者个人用户安装:

  pip install --user git-filter-repo
  

  安装后，你可能需要将 .local/bin （Linux/macOS）或 Python scripts 目录（Windows）添加到你的 PATH 环境变量中，以便直接运行 git filter-repo 命令 (参考引用)。

​git filter-repo 至少需要 Git 2.36.0 和 Python 3.6+ (参考引用)。

2. 在执行前确保 .env 已被 .gitignore 忽略

如果还没有，请在你的项目根目录下的 .gitignore 文件中添加一行：

.env

3. 执行 git filter-repo 命令

进入你的 Git 仓库的根目录，然后运行以下命令：

git filter-repo --path .env --invert-paths --force

• ​--path .env: 指定要处理的文件为 .env。
• ​--invert-paths: 这个选项告诉 git filter-repo 保留所有 除了 --path 指定的文件之外的内容。也就是说，所有包含 .env 的提交，都会被重写，把 .env 文件移除。
• ​--force: 强制执行操作，因为 filter-repo 默认会阻止对非新克隆仓库的修改，以防止意外数据丢失。

重要的注意事项：

• 在新克隆的仓库上执行！ 强烈建议在一个全新的、刚刚克隆下来的仓库副本上执行此操作。这样即使操作失误，你原有的仓库仍然安全。

  • git clone your_repo_url your_repo_clean
    cd your_repo_clean
    # 然后在这里执行 git filter-repo 命令
    

• ​git filter-repo 会自动处理所有的分支和标签。

4. 清理本地仓库

​git filter-repo 执行完毕后，它会自动进行一些清理工作。但作为好习惯，你仍然可以手动执行以下命令，确保所有旧的、不再引用的对象都被垃圾回收：

git reflog expire --expire=now --all && git gc --prune=now

• ​git reflog expire --expire=now --all: 这个命令会清理所有分支的 reflog 记录，将所有过期时间设置为“现在”，强制所有历史引用立即过期。Git 的 reflog 会记录你本地仓库中 HEAD 和其他引用的每一次移动，即使是历史重写后，旧的引用仍然可能存在于 reflog 中，阻止相关的对象被垃圾回收。
• ​git gc --prune=now: 这个命令会执行 Git 的垃圾回收 (garbage collection)， --prune=now 选项会立即删除所有不再被任何引用（包括 reflog）指向的对象。这可以显著减小仓库大小。

5. 强制推送到远程仓库

因为你重写了历史，你无法使用普通的 git push 命令。你需要强制推送。

警告： 强制推送会覆盖远程仓库的历史。这对于单人项目或你完全控制的项目来说是可行的。如果在团队项目中使用，必须提前与所有团队成员沟通，并确保他们都备份了工作并知道如何处理（通常需要删除本地仓库然后重新克隆）。

git push --force --all
git push --force --tags # 如果有标签的话，也推送更改后的标签

或者更安全的强制推送方式，使用 --force-with-lease：

git push --force-with-lease --all
git push --force-with-lease --tags

​--force-with-lease 会检查远程分支在你上次拉取后是否有新的提交。如果有，它会中止推送，防止你意外覆盖他人的工作。但在历史重写的情况下，本地和远程的历史会完全不同，所以仍然需要小心使用。

替代方法：git filter-branch (不推荐，但作为了解)

​git filter-branch 是 git filter-repo 的前身，功能类似但更复杂、更慢，并且有许多“坑”。Git 官方已经推荐使用 git filter-repo。

如果你出于某种原因无法使用 git filter-repo，可以使用 git filter-branch：

git filter-branch --force --index-filter \
"git rm --cached --ignore-unmatch .env" \
--prune-empty --tag-name-filter cat -- --all

• ​--force: 强制执行，即使有些 refs （比如 refs/original/refs/heads/master）已经存在，也会覆盖。
• ​--index-filter "...": 允许你对 Git 的索引（stage 区域）进行操作，而不需要检出每个版本的文件。这通常比 --tree-filter 快很多。
• ​git rm --cached --ignore-unmatch .env: 从索引中移除 .env 文件。--cached 意味着只从 Git 索引中删除，而不删除工作目录中的文件。--ignore-unmatch 意味着如果文件不存在，也不会报错。
• ​--prune-empty: 删除在过滤后变为空的提交。这不太可能发生在删除单个文件 .env 的情况下，但总归是个好选项。
• ​--tag-name-filter cat: 重写标签。cat 简单地将旧标签名作为新标签名。
• ​-- --all: 表示对所有分支和标签执行操作。

清理步骤 (针对 ​git filter-branch​​ )：

​git filter-branch 会在 refs/original/ 下创建旧提交的备份。你需要清理这些备份以彻底删除旧对象。

1. 删除 ​refs/original​​ 备份：

 git update-ref -d refs/original/refs/heads/master # 对每个分支重复
 # 或者删除所有：
 git for-each-ref --format="%(refname)" refs/original/ | xargs -n 1 git update-ref -d

2. 强制过期 reflog 并进行垃圾回收：

 git reflog expire --expire=now --all
 git gc --prune=now --aggressive

--aggressive 会使垃圾回收更彻底，但可能需要更多时间。

3. 强制推送到远程仓库 (与 git filter-repo 相同)。

总结与建议

• 备份！备份！备份！ 在开始前复制一份你的本地仓库。
• 使用 ​git filter-repo​​ 。 它是最新且最好的工具。
• 在新克隆的仓库上操作。 这是一个重要的安全措施。
• 确保 ​.env​​ 已在 ​.gitignore​​ 中。
• 通知团队成员并协调强制推送。 这是最重要的协作环节。

重写 Git 历史是一项强大的功能，但需要谨慎使用。一旦你强制推送，旧的历史将很难恢复。