【Git】直近のコミットメッセージを修正する

技術

はじめに

Gitでコミットをする際に、変更点を書き上げてからコミットすると思います。が、別のタスクと並行していたりして忙しかったりすると、変換ミスなどをしたままコミットしてしまうことがありますよね。

・・・ないですか?

ここでは「ある」と仮定して、コミットメッセージを修正する方法を記載します。

コミットメッセージの修正

直近のメッセージ修正(push前)

リモートリポジトリに反映されていない場合(git pushを実行していない)は、以下のコマンドを実行するとメッセージ修正ができます。

git commit --amend

このコマンドを実行すると、直前のメッセージがテキストエディタで起動されますので、誤りを修正してコミットを保存しましょう。

保存後、ログを確認すると修正されたコミットメッセージが表示されるようになっているはずです。ログの確認は以下のコマンドを使うなり、ツールがあればそれを使って見てください。

git log

直近のメッセージ修正(push済)

push済の場合でも、push前と同様のコマンドで修正することができます。ただし、pushする際、コミットログが書き変わってしまっているのでforce push(強制プッシュ)する必要があります。

git push --force-with-lease origin ブランチ名

最後に

忙しかったり慌てているときも、ひとまず落ち着いて丁寧に作業しましょう。それでもtypoは起こるので、ローカルで作業しているうちに過ちを正して、何事もなかったかのように公開していきましょう。

ここでは取り上げませんでしたが、古いメッセージや複数のメッセージの修正も可能です。参考文献のリンクにGitHub Docsへのリンクを用意していますので、必要あればそちらから参照ください。

参考文献

コミットメッセージの変更 - GitHub Docs
コミットメッセージに不明確、不正確、または機密情報が含まれている場合、ローカルでメッセージを修正して、GitHubに新しいメッセージで新しいコミットをプッシュできます。 また、コミットメッセージを変更して、不足している情報を追加することも可能です。

コメント

タイトルとURLをコピーしました