以前のgit commit で記述したログのコメントを書き換えるためのコマンドを教えてください

Question

下記の質問についてご存知の方がいらっしゃいましたら、ご教示を願います。

---

【質問の主旨】

git commit したときに記述した、先頭ではないコメントを変更するコマンドを教えてください。

【質問の補足】

下記のスクリーンショットにおいて「Update the package.json」というコメントの箇所が先頭になっています。一方コメントの内容を変更したいと考えている箇所は、「src/index.jsの更新」です。

「Update the package.json」のコメントを変更する場合は、単にgit commit --amend をして記述内容を変えれば良いと思いますが、以前のcommitに戻ってコメントを変更する方法が分かりません。

---

以上、よろしくお願いします。

Answer 1

念のための補足となりますが、リポジトリがローカルにしかない、あるいは完全に非公開なプロジェクトで、git push -fの影響範囲も明らか、はたまたプライベートキーのような書くべきでない情報を残してしまったというような場合を除けば、過去のコミットの改変はやるべきではありません。

そのリポジトリを使う全員にGitツリーの再構築を要求する（そうでなければ、古いコミットが残ってGitツリーが煩雑化する）ことになります。

Comments

[echizeyayota]

maisumakun さん。
コメントありがとうございます。

> 過去のコミットの改変はやるべきではありません。

このリポジトリは現在ローカル開発環境にありますが、ひょっとすると公開するかもしれません。
なので今回の具体例においては、コミットの改変をしないこととします。

今後ともどうぞよろしくお願いします。

[maisumakun]

> このリポジトリは現在ローカル開発環境にありますが、ひょっとすると公開するかもしれません。

まだローカルにしかないものであれば、何ら問題ありません。

Answer 2

参考記事: edit-コミットを修正する(rebaseを一時停止する) - git rebase についてまとめてみた | Qiita

普通のamendと同じ流れを利用することは可能です。

# コミット履歴を改ざんしてぶっ壊すのでバックアップを作成してそこで作業する
$ git checkout -b tmp

# コミットIDを取得する為に確認
$ git log

$ git rebase -i コミットID

# エディタが立ち上がるので、該当のコミットか次のコミットあたりをeditに変える

# コミットメッセージを変更
$ git commit --amend -m "ちゃんとしたコメント"

# 停止させていたコミット履歴を適用して完了
$ git rebase --continue

# コミット履歴が上手く改ざんできたら元のブランチになりかわる
$ git branch -D feature/branch
$ git checkout -b feature/branch
$ git branch -D tmp

まぁ、コミットメッセージを編集するだけならgit rebase -iしたタイミングで、
editではなくrewordを使うのが早いでしょうね。

rewordを指定すると再度エディタが立ち上がるので、
コミットメッセージ部分を適したメッセージに書き換えて保存終了するだけです。

Comments

[echizeyayota]

miyabi-sun さん。
コメントとリンクの紹介ありがとうございます。
maisumakun さんへのコメントで述べた通り、今回のリポジトリはひょっとすると公開するかもしれないので、コミット履歴を改ざんすることはやめておきます。
完全非公開のリポジトリで、どうしてもコミットの改ざんをしなければならないときに参考とさせていただきます。

今後ともどうぞよろしくお願いします。

[miyabi-sun]

> 今回のリポジトリはひょっとすると公開するかもしれないので
これは職場等で既に複数人の協業者が居る場合に該当します。
GitHubで既に公開済でも、一人プロジェクトと分かっているならお行儀が悪くてもそこまで問題にはなりません

なにはともあれ、コミット履歴を改ざんするなら
お行儀を一切気にしなくても良い公開前の今が最後のチャンスみたいな所があったりします。

公開・協業後はmasterの本流ブランチは絶対触るな！という感じになります。

それ以降の開発は基本的にmasterブランチにプルリクエストを使って少しずつ肉付けしていく形になりますが、
この時プルリクエスト用のブランチは、masterに取り込まれるまではもっと綺麗な整形が見つかったら、そこの部分だけコミット履歴を改ざんするというケースは多いです。

この辺の事情から手順は理解しておいたほうが良いと思うので回答してあります。