修改 git 歷史提交 commit 信息(重寫歷史)

背景

近期在做一些開源項目的時候,提交 pull request 有些會要求提交 DCO 信息,用于 CI 的驗證.簡單來說就是,要在提交信息中增加例如

Signed-off-by: Random J Developer <random@developer.example.org>

的提交信息,前面文檔也提到過,增加這行信息其實很簡單,就是在提交 git commit 的時候,加上-s 參數即可.

$ git commit -s -m 'This is my commit message'

但是我們今天要解決的問題是, git 已經提交了,如何去修改以前的提交信息,讓他也附加上這樣的提交信息,如果不修改,那么 CI 校驗 一定過不了,在 有 DCO 的項目中,會有如下的提示:


image.png

項目 owner 一般會要求你修改歷史的 commit 信息,必須通過 CI 校驗.

解決方法

修改最新的 log

  • 如果只修改最新一條提交信息的 log 內容,直接使用命令 git commit --amend 就可以完成修改啦, 可以直接參考 git 文檔,也就是下面的 重寫歷史 功能,比較簡單.

修改歷史的 log

如果要修改歷史的版本信息(非最新一條),會稍稍麻煩一點,不過也可以搞定,這里用到的方法就是 git命令的重寫歷史功能.

  • 假定我們現在的提交信息是這樣的
$ git log
commit 9ac1179332670365a3e5ea00a6486998eb66db7a (HEAD -> fix_aop_no_class_defined, origin/fix_aop_no_class_defined)
Author: candyleer <295198088@qq.com>
Date:   Mon Apr 16 19:58:23 2018 +0800

    update test case

    Signed-off-by: candyleer <295198088@qq.com>

commit 223fc80d17273b19238dcb648e6d6eefc579de0f
Author: candyleer <295198088@qq.com>
Date:   Mon Apr 16 18:47:50 2018 +0800

    unit test case

    Signed-off-by: candyleer <295198088@qq.com>

commit 2275781a0d75add037721832bd68c1a8edb3813e
Author: candyleer <295198088@qq.com>
Date:   Mon Apr 16 18:29:29 2018 +0800

    should find method from parent

一共有三條歷史提交信息,第 二三條都已經加上了 DCO 信息,現在想在第一條(最老的一條)的提交信息上面也加上的話.我們可以按照上述文檔操作:

  • 執行 git 命令, 修改近三次的信息
$ git rebase -i HEAD~3

將會得到如下的信息,這里的提交日志是和git log倒敘排列的,我們要修改的日志信息位于第一位.

  1 pick 2275781 should find method from parent
  2 pick 223fc80 unit test case
  3 pick 9ac1179 update test case
  4
  5 # Rebase 79db0bd..9ac1179 onto 79db0bd (3 commands)
  6 #
  7 # Commands:
  8 # p, pick = use commit
  9 # r, reword = use commit, but edit the commit message
 10 # e, edit = use commit, but stop for amending
 11 # s, squash = use commit, but meld into previous commit
 12 # f, fixup = like "squash", but discard this commit's log message
 13 # x, exec = run command (the rest of the line) using shell
 14 # d, drop = remove commit
 15 #
 16 # These lines can be re-ordered; they are executed from top to bottom.
 17 #
 18 # If you remove a line here THAT COMMIT WILL BE LOST.
 19 #
 20 # However, if you remove everything, the rebase will be aborted.
 21 #
 22 # Note that empty commits are commented out
  • 我們現在要修改修改要should find method from parent這條日志,那么修改的日志為,將第一個pick 修改為edit, 然后 :wq 退出.
  1 edit 2275781 should find method from parent
  2 pick 223fc80 unit test case
  3 pick 9ac1179 update test case

將會看到如下信息,意思就是如果要改日志,執行git commit --amend,如果修改完成后,執行git rebase --continue

client_java git:(fix_aop_no_class_defined) git rebase -i HEAD~3
Stopped at 2275781...  should find method from parent
You can amend the commit now, with

  git commit --amend

Once you are satisfied with your changes, run

  git rebase --continue
?  client_java git:(2275781)
  • 正式修改,執行命令,-s 就是自動加上Signed-off-by:
$ git commit --amend -s 

client_java git:(63b2cfd) git commit --amend -s
[detached HEAD c46b30e] 1should find method from parent
 Date: Mon Apr 16 18:29:29 2018 +0800
 1 file changed, 4 insertions(+), 1 deletion(-

修改完成后,:wq 退出,然后完成此次 log 的rebase

$ git rebase --continue

client_java git:(c46b30e) git rebase --continue
Successfully rebased and updated refs/heads/fix_aop_no_class_defined.
  • 這樣本地修改就完成啦,用git log 再看下:
commit 449efc747ffb85567667745b978ed7e3418cfe27 (HEAD -> fix_aop_no_class_defined)
Author: candyleer <295198088@qq.com>
Date:   Mon Apr 16 19:58:23 2018 +0800

    update test case

    Signed-off-by: candyleer <295198088@qq.com>

commit 69237c0bd48439ea0d8b87bf2c7c7ac4786c66d4
Author: candyleer <295198088@qq.com>
Date:   Mon Apr 16 18:47:50 2018 +0800

    unit test case

    Signed-off-by: candyleer <295198088@qq.com>

commit c46b30e456af6ecdf4a629a485e5efe5485e52b1
Author: candyleer <295198088@qq.com>
Date:   Mon Apr 16 18:29:29 2018 +0800

    1should find method from parent

    Signed-off-by: candyleer <295198088@qq.com>

所有信息都有Signed-off-by:這個參數了

  • 最后push 到遠程倉庫,所有的 DCO 就都可以加上啦,-f強制推送
$  git push origin <you_branch_name> -f

再次查看 github 的 CI,DCO 相關的就check pass

image.png

  • over
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Add & Commit git init 初始化一個 Git 倉庫(repository),即把當前所在目錄變成...
    冬絮閱讀 4,884評論 0 9
  • 以下筆記主要參考gitgot,大致了解git使用和原理。 第一部分我們從個人的視角去研究如何用好Git,并且揭示G...
    carolwhite閱讀 2,415評論 0 1
  • 1. GIT命令 git init在本地新建一個repo,進入一個項目目錄,執行git init,會初始化一個re...
    江邊一蓑煙閱讀 826評論 0 0
  • 一、基本概念: 注:對于git的分布式概念及其優點,不重復說明,自己百度或谷歌。本文中涉及到指令前面有$的,在cm...
    大廠offer閱讀 1,442評論 0 3
  • 這不是一篇讀后感,不過我依然想寫。因為關于讀書,有的感動需要銘記。 6月5號大冰又出新書了。這是繼《乖,摸摸頭》、...
    縫歲閱讀 3,364評論 2 2