如何替换 git 历史记录中文件中的文本？

Question

我一直使用基于界面的 git 客户端（smartGit），因此对 git 控制台没有太多经验。

但是，我现在需要替换历史记录中所有 .txt 文件中的字符串（因此，不会删除整个文件，而只是替换字符串）。我发现了以下命令：

git filter-branch --tree-filter 'git ls-files -z "*.php" |xargs -0 perl -p -i -e "s#(PASSWORD1|PASSWORD2|PASSWORD3)#xXxXxXxXxXx#g"' -- --all

我尝试了这个，不幸的是注意到虽然密码确实被更改，但所有二进制文件都已损坏。图像等都会被损坏。

有没有更好的方法来做到这一点，不会损坏我的二进制文件？

谢谢。

编辑：

我混淆了一些东西。导致二进制文件损坏的实际代码是：

$ git filter-branch --tree-filter "find . -type f -exec sed -i -e 's/originalpassword/newpassword/g' {} \;"

顶部的代码实际上删除了带有我的密码的所有文件，这很奇怪。

Answer 1

我建议使用 BFG Repo-Cleaner，这是一个更简单、更快的替代方案git-filter-branch 专为重写 Git 历史记录中的文件而设计。

您应该仔细按照以下步骤操作： https://rtyley.github.io/bfg -repo-cleaner/#usage - 但核心位就是这样：下载 BFG 的 jar（需要 Java 7 或更高版本）并运行此命令（其中 my-repo.git 是存储库裸克隆的文件夹名称）：

$ java -jar bfg.jar  --replace-text replacements.txt -fi '*.php'  my-repo.git

replacements.txt 文件应包含您想要执行的所有替换，格式如下（每行一个条目 - 请注意不应包含注释）：

PASSWORD1 # Replace literal string 'PASSWORD1' with '***REMOVED***' (default)
PASSWORD2==>examplePass         # replace with 'examplePass' instead
PASSWORD3==>                    # replace with the empty string
regex:password=\w+==>password=  # Replace, using a regex
regex:\r(\n)==>$1               # Replace Windows newlines with Unix newlines

您的整个存储库历史记录将被扫描，并且 < code>.php 文件（大小低于 1MB）将执行替换：任何匹配的字符串（不在您的最新提交中）都将被替换。

全面披露：我是 BFG Repo-Cleaner 的作者。

Answer 2

您可以通过将 -name "pattern" 传递给 find 来避免触及不需要的文件。

这对我有用：

git filter-branch --tree-filter "find . -name '*.php' -exec sed -i -e \
    's/originalpassword/newpassword/g' {} \;"

Answer 3

在 Git 2.24（2019 年第 4 季度）中，git filter-branch（和 BFG）已弃用。

newren/git-filter-repo< /a> 确实不做你想做的事。
它有一个示例，几乎是您想要的 示例部分：

cd repo
git filter-repo --path-glob '*.txt' --replace-text expressions.txt

带有 expressions.txt：

literal:originalpassword==>newpassword

但是，警告< /strong>：正如 Hasturkun 添加在 评论

使用--path-glob（或--path）会导致git filter-branch仅保留与这些匹配的文件规格。
仅替换特定文件中文本的功能在 bfg-ish 中可用，如 -fi 或 lint-history 脚本。
否则，目前看来这只能通过自定义提交回调实现。
请参阅 newren/git-filter-repo 问题 74< /a>

这是有道理的，考虑到 --replace-text 选项本身就是一个 blob 回调。

---

2024 年第一季度，newren/git-filter-repo< /code> 第 74 期建议（来自 Daniil）：

解决方案

git filter-branch --tree-filter "find . -path './src/*' -regextype egrep -regex '.*\.(hpp|cpp)' -exec perl -0777 -pe 's{\n\n\n+}{\n\n}g' -i {} \;" <分支/HEAD/哈希..HEAD>

它将“>1 个空行”替换为单个空行

Answer 4

有关 git-filter-repo 的更多信息

https://stackoverflow.com/ a/58252169/895245 提供了基础知识，这里有一些更多信息。

安装

从 git 2.5 开始，至少它不随主线 git 一起提供，因此：https://superuser.com/questions/1563034/how-do-you-install-git-filter-repo/1589985#1589985

python3 -m pip install --user git-filter-repo

使用提示

这是我倾向于使用的更常见的方法：

git filter-repo --replace-text <(echo 'my_password==>xxxxxxxx') HEAD

其中：

• Bash 进程替换允许我们不创建用于简单替换的文件。如果您的 shell 不支持此功能，您只需将其写入文件即可：

  echo 'my_password==>xxxxxxxx' > tmp
  git filter-repo --replace-text tmp HEAD
  

• HEAD 使其仅影响当前分支

仅修改一系列提交

如何使用 git filter-repo 仅修改一系列提交而不是整个分支历史记录？

git filter-repo --replace-text <(echo 'my_password==>xxxxxxxx') --refs HEAD~2..HEAD

使用Python API替换

对于更复杂的替换，可以使用Python API，参见：如何使用 git filter-repo 作为带有 Python 模块接口的库？

Answer 5

我在 /usr/local/git/findsed.sh 创建了一个文件，其中包含以下内容：

find . -name 'githubDirToSubmodule.sh' -exec sed -i '' -e 's/What I want to remove//g' {} \;

我运行了命令：

git filter-branch --tree-filter "sh /usr/local/git/findsed.sh"

命令说明

当您运行 git filter-branch 时，它会遍历每个修订版你曾经承诺过，一一承诺。 --tree-filter 在每个提交的修订上运行founded.sh 脚本，保存它，然后进入下一个修订。

find 命令查找特定文件或文件集，并在该文件上执行 (-exec) sed 编辑器。 sed 是一个命令，它采用 s/ 之后的正则表达式并将其替换为 / 和 /g 之间的字符串（在我的示例中为空白）。 {} 是对 find 命令给出的文件路径的引用。文件路径被提供给 sed，以便 sed 知道要处理什么。 \;只是结束 -exec 命令。

将 shell 脚本和命令分成单独的部分可以减少引用 '' 或 "" 时的复杂性。

特点

我在 Mac 上成功实现了这个，显然 sed 是 Mac 上的一个特定（较旧的？）版本。这很重要，因为它有时表现不同。确保执行 sed -i '' ，否则它会在文件末尾添加一个“-e”，认为这就是我想要命名的备份文件。 -i '' 表示不创建备份文件，只需就地编辑文件，不需要备份文件。

指定 -name 'filename.sh' 帮助我避免了另一个我无法解决的问题。还有另一个带有 .sh 的文件，该文件结束时没有换行符。 sed 由于某种原因，会在末尾添加一个换行符，尽管 's/blah/blah/g' 与该文件中的任何内容都不匹配。因此，我没有解决这个问题，而是告诉 find 忽略所有其他文件。

有效的其他命令

此外，我发现这些命令可以在finded.sh 文件中使用（一次只能使用一个命令，不能使用多个命令，因此请将其他命令注释掉）：

find . -name '.publishNewZenPackFromGithub.sh.swp' -exec rm -f {} \;
find . -name '*' -exec grep -H PassToRemove {} \;

享受吧！

Answer 6

可能是 shell 扩展问题。如果 filter-branch 在执行命令时丢失了 "*.php" 周围的引号，则它可能会扩展为空，因此 git ls-files -z列出所有文件。

您可以检查过滤器分支源代码或尝试不同的引用技巧，但我要做的只是制作一个单行 shell 脚本来执行树过滤器并传递该脚本。

Answer 7

由于 Google 中出现了 git 替换历史记录中的文本，并且由于使用非 git 工具有时麻烦大于其价值，因此这里有一个将替换多行文本的命令 strong> 从 ${COMMIT} 一直到 HEAD。

警告：这不适合初学者。它使用 git filter-branch ，所以它的所有警告/陷阱/等等。申请。确保您已提交/备份了需要保存的所有内容，这样就不会丢失数据。

话虽如此，在 Bash 中创建别名，如下所示：

git config --global alias.filter-branch-replace-text '!main() { set -eu && if [ -n "${BASH_VERSION+x}" ]; then set -o pipefail; fi && local pattern patternq replacement replacementq commit && pattern="$1" && shift && replacement="$1" && shift && commit="$1" && shift && local sed_binary_flags="" && if [ msys = "${OSTYPE-}" ]; then sed_binary_flags="-b"; fi && patternq="$(printf "%s" "${pattern}" | sed ${sed_binary_flags} "s/'\''/'\''\\\\'\'''\''/g")." && patternq="'\''${patternq%.}'\''" && replacementq="$(printf "%s" "${replacement}" | sed ${sed_binary_flags} "s/'\''/'\''\\\\'\'''\''/g")." && replacementq="'\''${replacementq%.}'\''" && git filter-branch --tree-filter "for path in $(printf "%s\n" "$@" | sed ${sed_binary_flags} -e "s/'\''/'\''\\\\'\'''\''/g" -e "s/\(.*\)/'\''\1'\''/" | tr "\n" " ")"'\''; do if [ -f "${path}" ]; then perl -0777 -i -s -p -e "s/\\Q\$q\\E/\$s/sgm" -- -q='\''"${patternq}"'\'' -s='\''"${replacementq}"'\'' -- "${path}"; fi || break; done'\'' "${commit}~1..HEAD" --; } && main'

然后您可以从 Bash 调用它，如下所示：

git filter-branch-replace-text \
    
请注意，这执行文字文本替换，而不是正则表达式替换。
如果您需要正则表达式，则需要删除 Perl 命令中的 \Q 和 \E （执行转义），并根据 < 需要正确转义字符串。 code>s/$q/$s/sgm 自己命令。
如果你想漂亮地打印脚本，你可以将其格式化如下：
(f="$(git --no-pager config --get alias.filter-branch-replace-text)" && eval "${f%&&*}" && declare -f "${f%%()*}")

)\r\n{' \
    
请注意，这执行文字文本替换，而不是正则表达式替换。
如果您需要正则表达式，则需要删除 Perl 命令中的 \Q 和 \E （执行转义），并根据 < 需要正确转义字符串。 code>s/$q/$s/sgm 自己命令。
如果你想漂亮地打印脚本，你可以将其格式化如下：

) /* EOL */\r\n{' \
    "${COMMIT}" \
    src/*.txt

请注意，这执行文字文本替换，而不是正则表达式替换。

如果您需要正则表达式，则需要删除 Perl 命令中的 \Q 和 \E （执行转义），并根据 < 需要正确转义字符串。 code>s/$q/$s/sgm 自己命令。

如果你想漂亮地打印脚本，你可以将其格式化如下：