Article version: Enterprise Server 2.17
Changing a commit message
If a commit message contains unclear, incorrect, or sensitive information, you can amend it locally and push a new commit with a new message to GitHub Enterprise. You can also change a commit message to add missing information.
You can change the most recent commit message using the
git commit --amend command.
In Git, the text of the commit message is part of the commit. Changing the commit message will change the commit ID--i.e., the SHA1 checksum that names the commit. Effectively, you are creating a new commit that replaces the old one.
If the commit only exists in your local repository and has not been pushed to your GitHub Enterprise Server instance, you can amend the commit message with the
git commit --amend command.
- On the command line, navigate to the repository that contains the commit you want to amend.
git commit --amendand press Enter.
- In your text editor, edit the commit message, and save the commit.
- You can add a co-author by adding a trailer to the commit. For more information, see "Creating a commit with multiple authors."
The new commit and message will appear on your GitHub Enterprise Server instance the next time you push.
You can change the default text editor for Git by changing the
core.editor setting. For more information, see "Basic Client Configuration" in the Git manual.
If you have already pushed the commit to your GitHub Enterprise Server instance, you will have to force push a commit with an amended message.
We strongly discourage force pushing, since this changes the history of your repository. If you force push, people who have already cloned your repository will have to manually fix their local history. For more information, see "Recovering from upstream rebase" in the Git manual.
Amending the message of the most recently pushed commit
- Follow the steps above to amend the commit message.
- Use the
push --forcecommand to force push over the old commit.
$ git push --force example-branch
Amending the message of older or multiple commit messages
If you need to amend the message for multiple commits or an older commit, you can use interactive rebase, then force push to change the commit history.
On the command line, navigate to the repository that contains the commit you want to amend.
git rebase -i HEAD~ncommand to display a list of the last
ncommits in your default text editor.
# Displays a list of the last 3 commits on the current branch $ git rebase -i HEAD~3
The list will look similar to the following:
pick e499d89 Delete CNAME pick 0c39034 Better README pick f7fde4a Change the commit message but push the same commit. # Rebase 9fdb3bd..f7fde4a onto 9fdb3bd # # 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 # # 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
rewordbefore each commit message you want to change.
pick e499d89 Delete CNAME reword 0c39034 Better README reword f7fde4a Change the commit message but push the same commit.
Save and close the commit list file.
In each resulting commit file, type the new commit message, save the file, and close it.
Force-push the amended commits.
$ git push --force
For more information on interactive rebase, see "Interactive mode" in the Git manual.
As before, amending the commit message will result in a new commit with a new ID. However, in this case, every commit that follows the amended commit will also get a new ID because each commit also contains the id of its parent.
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 Enterprise. The old commit will not be a part of a subsequent clone; however, it may still be cached on GitHub Enterprise and accessible via the commit ID. You must contact your GitHub Enterprise site administrator with the old commit ID to have it purged from the remote repository.