144

Is there a way to edit a commit message after committing and pushing to GitHub? I see that there is a 'add a note' as well as inline commenting, but no actual editing of a commit message. There is also 'amend commit' in git extensions but that doesn't edit the existing message.

Community
  • 1
Matthew Peters
  • 1,828
  • 3
  • 13
  • 14

7 Answers7

196

  1. git rebase -i <commit hash you want to change>^

    This will open your default editor (usually ) with a list of commits and actions for each one. By default, the action is pick.

  2. For any commit you wish to change the message, change pick to reword.

  3. Save and quit (in vi: :wq).

  4. For each such commit, you'll get an editor to edit the commit message. Change it as you see fit, save and quit.

    Once you're done editing all the commit messages, you'll return to the command prompt, and have a new tree with the updated messages.

  5. You can now upload them to github by using git push origin --force.

If you just need to fix your last commit, you can replace steps 1-4 with git commit --amend.

Community
  • 1
Mureinik
  • 4,152
35

In Intellij Idea you can do it so easy.

  1. Open Version Control (History)
  2. Select log tab
  3. Select commit to change comment
  4. press F2 (Mac fn + F2), and update your commit message
Nathan.Eilisha Shiraini
  • 2,674
fedrbodr
  • 459
5

Premise:

if your git-graph looks like ...

O   target-commit that you want to change its message [df9c192]
|
O   parent-commit [b7ec061]
|
O

(df9c192 and b7ec061 are the commit hashes of target-commit and parent-commit, separately)

Solution:

you can just type the following instructions...

git reset --soft b7ec061
git commit -m "your_new_description"
git push -f

Explanation:

  1. git reset --soft b7ec061 will keep your changes of files and reset to parent-commit (i.e. b7ec061)
  2. git commit -m "..." will locally create a new commit
  3. git push -f will push your new commit to the server and replace the old one (i.e. df9c192)
KY Lu
  • 151
2

Another option is to create an additional "errata commit" (and push) which references the commit object that contains the error -- the new errata commit also provides the correction. An errata commit is a commit with no substantive code changes but an important commit message -- for example, add one space character to your readme file and commit that change with the important commit message, or use the git option --allow-empty. It's certainly easier and safer than rebasing, it doesn't modify true history, and it keeps the branch tree clean (using amend is also a good choice if you are correcting the most recent commit, but an errata commit may be a good choice for older commits). This type of thing so rarely happens that simply documenting the mistake is good enough. In the future, if you need to search through a git log for a feature keyword, the original (erroneous) commit may not appear because the wrong keyword was used in that original commit (the original typo) -- however, the keyword will appear in the errata commit which will then point you to the original commit that had the typo. Here's an example:

$ git log
commit 0c28141c68adae276840f17ccd4766542c33cf1d
Author: First Last 
Date:   Wed Aug 8 15:55:52 2018 -0600

    Errata commit:
    This commit has no substantive code change.
    THis commit is provided only to document a correction to a previous commit message.
    This pertains to commit object e083a7abd8deb5776cb304fa13731a4182a24be1
    Original incorrect commit message:
        Changed background color to red
    Correction (*change highlighted*):
        Changed background color to *blue*

commit 032d0ff0601bff79bdef3c6f0a02ebfa061c4ad4
Author: First Last 
Date:   Wed Aug 8 15:43:16 2018 -0600

    Some interim commit message

commit e083a7abd8deb5776cb304fa13731a4182a24be1
Author: First Last 
Date:   Wed Aug 8 13:31:32 2018 -0600

    Changed background color to red
rob_7cc
  • 131
0

Answer of @Mureinik is good but not understandable by newbie.

First method:

  1. If you only want to edit latest commit message, then you only need git commit --amend, you would see:
<your existing commit mesage foo bar> 

# Please enter the commit message fir your changes. Lines starting
# with # will be ignored, and an empty message aborts the commit.
#
# Date: Sat Aug 24 17:56:16 2019 +0800
#
# On branch is up to date with 'origin/master'.
#
# changes to be committed:
#       modified:   foo.py
#
  1. As you can see, commit message on top without any prefix of command such as pick, this is already the edit page and you can direct edit the top message and save&quit, e.g.:
<your new correction commit message> 

# Please enter the commit message for your changes. Lines starting
....
  1. Then do git push -u origin master --force or <how you push normally> --force. The key here is --force.

Second method:

  1. You can see the commit hash by git log or extract from the repository url, example in my case is 881129d771219cfa29e6f6c2205851a2994a8835

  2. Then you can do git rebase --interactive 881129d771219cfa29e6f6c2205851a2994a8835 or git rebase -i HEAD^ (if the latest)

  3. You would see:

pick <commit hash> <your current commit message>

# Rebase 8db7e8b..fa20af3 onto 8db7e8b
#
# 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
#  d, drop = remove commit
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out
  1. But if you see noop then you are probably typing wrong, e.g. if you do git rebase -i 881129d771219cfa29e6f6c2205851a2994a88 which missing ^ at the end, you better quit the editor without save and figure out the reason:
noop

# Rebase 8db7e8b..fa20af3 onto 8db7e8b
...
  1. If no noop issue, then simply change the word pick to reword , other just remains (you don't edit commit message at this point), e.g:
reword <commit hash> <your current commit message>

# Rebase 8db7e8b..fa20af3 onto 8db7e8b
#
# Commands:
#  p, pick = use commit
...
  1. Save&quit will see the edit page similar to method #1:
<your existing commit mesage foo bar> 

# Please enter the commit message fir your changes. Lines starting
# with # will be ignored, and an empty message aborts the commit.
#
# Date: Sat Aug 24 17:56:16 2019 +0800
#
# interactive rebase in progress; onto b057371
# Last command done (1 command done):
#    reword d996ffb <existing commit message foo bar>
# No commands remaining.
# You are currently editing a commit while rebasing branch 'master' on 'b057371'.
#
# changes to be committed:
#       modified:   foo.py
#
  1. Edit the message on top, same like method #1 and save&quit, e.g:
<your new correction commit message> 

# Please enter the commit message for your changes. Lines starting
....
  1. Again, same like method #1, do git push -u origin master --force or <how you push normally> --force. The key here is --force.

For more info please read the doc.

林果皞
  • 455
0

If one needs to edit an incorrect commit message in Git, one can use git commit --amend without making any changes to the index, Git still allows one to edit the commit message if one likes, or one can give the new message with the -m option such as

git commit --amend -m "COMMIT MESSAGE"

This still requires replacing the last commit, since the message text is part of the commit; the new commit will just have the same content (point to the same tree) as the previous one.

Here are GitHub's guidelines for changing a commit message

  1. Rewriting the most recent commit message

  2. Commit has not been pushed online

  3. Amending older or multiple commit messages

Important note

If you have included sensitive information in a commit message, force pushing a commit with an amended commit may not remove the original commit from GitHub. The old commit will not be a part of a subsequent clone; however, it may still be cached on GitHub and accessible via the commit ID. You must contact GitHub Support or GitHub Premium Support with the old commit ID to have it purged from the remote repository.

Gonçalo Peres
  • 911
0

If you use VSCode, you can revert the commit and get all of the changes (and the original commit message) in the commit thingy, then you can commit again. (this possibly might mess up the order of the commits though)

Andrew
  • 1