---

Git 修改 Commit Message 完整教程

在 Git 版本控制中，提交信息（Commit Message）是项目历史记录的重要组成部分。清晰、准确的提交信息能够帮助团队成员理解每次变更的目的、内容和原因，从而提高协作效率和代码可维护性。然而，在开发过程中，我们难免会遇到需要修改已提交的 Commit Message 的情况，例如：

• 修正拼写错误或语法问题。
• 补充遗漏的信息或提供更详细的上下文。
• 统一提交信息格式。
• 在合并或重构历史时调整信息。

Git 提供了多种灵活的方法来修改 Commit Message，但需要注意的是，修改提交历史，特别是那些已经推送到远程仓库并与他人共享的提交，需要极其谨慎。 因为这会改变提交的 SHA-1 值，可能影响团队成员的本地仓库，甚至导致冲突。

本文将详细介绍修改 Git Commit Message 的几种常用方法，并提供操作步骤和注意事项。

1. 修改最近一次提交的 Commit Message (git commit --amend)

这是最常见也最简单的场景。当你刚刚完成一次提交，但很快发现提交信息有误、不完整，或者想要追加一些小改动时，可以使用 git commit --amend 命令。

--amend 选项会替换上一次提交，而不是在其基础上创建新的提交。

操作步骤：

1. 执行命令： 在命令行中输入：
   bash
git commit --amend
2. 编辑提交信息： Git 会打开你配置的默认文本编辑器（如 Vim、Nano 或 VS Code），其中显示了上一次提交的信息。
3. 保存并关闭： 编辑提交信息，修改完成后保存并关闭编辑器。
   • 直接在命令行修改： 如果你只打算简单地修改提交信息，也可以直接在命令后面使用 -m 选项：
     bash
git commit --amend -m "新的、更准确的提交信息"
   • 追加代码改动： 如果在执行 git commit --amend 之前，你还 git add 了一些新的改动，这些改动也会被合并到上一次提交中，形成一个新的“最终”提交。

注意事项：

• SHA-1 值改变： git commit --amend 会创建一个新的 commit 对象来替换旧的 commit 对象，因此即使内容不变，提交的 SHA-1 值也会发生改变。
• 尚未推送的提交： 如果上一次提交尚未推送到远程仓库，那么修改后直接进行 git push 即可。
• 已推送的提交： 如果上一次提交已经推送到远程仓库，你需要使用强制推送才能更新远程分支：
  bash
git push --force # 强制推送，不推荐在团队中使用
git push --force-with-lease # 更安全的强制推送，推荐
--force-with-lease 会检查远程分支是否在上次拉取后有新的提交。如果有，它将拒绝强制推送，从而避免覆盖他人工作。

2. 修改较早或多个提交的 Commit Message (git rebase -i)

当你需要修改历史中较早的某个提交，或者需要修改多个提交的信息时，git rebase -i（交互式 rebase）是你的强大工具。

操作步骤：

1. 确定 Rebase 范围： 运行 git rebase -i HEAD~N 命令。
   其中 N 是你想要修改的 commit 数量。例如，如果你想修改最近的 3 个提交，命令就是 git rebase -i HEAD~3。如果你想修改某个特定提交之前的提交（不包括该提交），可以使用该提交的 SHA-1 值：git rebase -i <commit-sha>^ （注意 ^ 符号）。

2. 进入交互式编辑器： Git 会打开一个交互式编辑器，列出你选择的 N 个提交，通常从最旧的开始显示。

   “`
   pick 873dfac Rename file name
   pick f7f3f6d Change my name a bit
   pick 310154e Update README formatting and add blame

   Rebase 710f0f8..310154e onto 710f0f8

   Commands:

   p, pick = use commit

   r, reword = use commit, but edit the commit message

   e, edit = use commit, but stop for amending

   s, squash = use commit, but meld into previous commit

   f, fixup = like “squash”, but discard this commit’s log message

   x, exec = run command (the rest of the line) using shell

   b, break = stop here (continue rebase later with ‘git rebase –continue’)

   d, drop = remove commit

   … (其他命令说明) …

   3. **标记要修改的提交：** 找到你想要修改的提交，将其前面的 `pick` 命令改为 `reword`（或简写 `r`）。
例如，如果你想修改 `f7f3f6d` 这个提交的信息：
   pick 873dfac Rename file name
   reword f7f3f6d Change my name a bit
   pick 310154e Update README formatting and add blame
   ``
4. **保存并关闭第一个编辑器。**
5. **修改 Commit Message：** Git 会逐个停在你标记为reword的提交上，并为你打开一个新的编辑器，让你修改该提交的信息。
6. **保存并关闭第二个编辑器：** 修改完成后，保存并关闭编辑器。
7. **继续 Rebase：** 如果有多个reword的提交，Git 会重复步骤 5 和 6，直到所有标记的提交都修改完毕。
8. **完成 Rebase：** 如果一切顺利，Git 会提示Successfully rebased and updated …`。

git rebase -i 的其他常用命令：

除了 reword，交互式 rebase 还支持其他强大的功能：

• pick (p): 正常使用该提交。
• edit (e): 使用该提交，但停下来允许你修改该提交（例如，你可以 git commit --amend 添加新的改动，或者修改提交信息）。完成后使用 git rebase --continue 继续。
• squash (s): 使用该提交，并将其与前一个提交合并。该提交的信息会与前一个提交的信息合并，并允许你编辑新的合并信息。
• fixup (f): 类似于 squash，但会丢弃该提交自己的日志信息，只保留前一个提交的信息。
• drop (d): 移除该提交。

注意事项：

• 重写历史： 交互式 rebase 也会重写历史，改变所有涉及到的提交及其后续提交的 SHA-1 值。
• 已推送的提交： 如果这些提交已经推送到远程仓库，你同样需要使用 git push --force 或 git push --force-with-lease 进行强制推送。
• 冲突解决： 在 rebase 过程中，可能会遇到代码冲突。你需要手动解决冲突，然后使用 git add . 暂存更改，最后运行 git rebase --continue 继续 rebase 过程。

3. 批量修改 Commit Message 或更复杂的历史重写 (git filter-repo)

对于需要进行更复杂的历史重写任务，例如批量修改所有提交信息中的某个特定字符串、删除所有提交中包含的某个文件，或者修改所有提交的作者信息，官方推荐使用 git filter-repo 工具。

git filter-repo 是一个强大的第三方工具，它比 Git 内置的 git filter-branch 工具更快、更安全，并且避免了 filter-branch 的许多潜在陷阱。

安装 git filter-repo：

git filter-repo 需要 Python 3 和 pip。

“`bash

使用 pip 安装

pip install git-filter-repo

或者通过 Homebrew (macOS)

brew install git-filter-repo
“`

使用 git filter-repo 修改 Commit Message 示例：

假设你想修改所有提交信息中包含 “old_keyword” 的部分，将其替换为 “new_keyword”。

1. 确保在仓库根目录。
2. 执行命令：
   bash
git filter-repo --message-callback 'return message.replace(b"old_keyword", b"new_keyword")'
--message-callback 选项允许你提供一个 Python 函数，该函数会接收每个提交的 message 作为字节串，并返回修改后的字节串。

注意事项：

• 强大的历史重写： git filter-repo 是一个非常强大的工具，能够彻底重写整个仓库的历史。在使用之前，务必备份你的仓库！
• 不可逆转： 大多数 git filter-repo 操作是不可逆转的。一旦执行，旧的历史记录就会被清除。
• 团队协作： 如果你的仓库是与他人共享的，在使用 git filter-repo 后，所有协作者都需要重新克隆仓库，或者进行复杂的历史同步操作。因此，在共享仓库中谨慎使用此工具，并与团队成员充分沟通。

4. 关于强制推送 (git push --force 与 git push --force-with-lease)

当你修改了已推送到远程仓库的提交历史时，由于本地分支的 HEAD 指向的提交与远程分支的 HEAD 不再是线性关系（即远程分支没有包含你本地修改后的提交，反之亦然），Git 会拒绝普通的 git push。此时你需要使用强制推送。

• git push --force: 强行覆盖远程分支，不进行任何检查。如果同时有其他人向远程分支推送了新的提交，你的强制推送会覆盖掉他人的工作。非常危险，应尽量避免使用。
• git push --force-with-lease: 安全地强制推送。它会检查远程分支是否在上次你拉取之后有新的提交。如果没有，则允许强制推送；如果有，则拒绝推送，从而避免覆盖他人工作。强烈推荐使用此命令代替 --force。

结论

修改 Git Commit Message 是一个常见的需求，Git 提供了从简单到复杂的多种解决方案。

• 修改最近一次提交： 使用 git commit --amend，简单高效。
• 修改较早或多个提交： 使用 git rebase -i，功能强大且灵活。
• 批量或复杂历史重写： 推荐使用 git filter-repo，但需格外小心，并做好备份。

无论使用哪种方法，当涉及到已推送到远程仓库的提交时，都务必谨慎操作。 优先考虑与团队成员沟通，并在确认不会影响他人工作的前提下，使用 git push --force-with-lease 进行强制推送。保持清晰、准确的提交历史是良好开发实践的重要组成部分。

---