Skip to main content

How to Change a Git Commit Message?

Image
By



Git history

In this tutorial, we'll go over how to fix Git commit messages that have been committed to a local or remote Git repository.

Reason to change commit message?

When working with Git, there could be several reasons to update the commit message.
Some of the common reasons are as follows:
  • Message contains a typo.
  • Missing intent of commit.
  • Remove any confidential information.
  • Correct issue ticket number to connect to an issue tracker such as Jira.

Solution

The reason could be anything, but you should be aware of the command to update the commit message at any point in the development of your application.

Let's take a look at the solution for a single commit message.

local commit

Assume you perform the following Git operation

$ git add -A
$ git commit -m "[PROJECT-99] - Added user profile module."

And after you realise that the issue number for the current commit is incorrect and needs to be corrected. That's the story of Project 100.

You can correct it using the method outlined below.

$ git commit --amend -m "[PROJECT-100] - Added user profile module."
 
If you look at git log then updated message will reflect in it.

commit 75c82d058b32b82b5724618c816684c5aaa59022 (HEAD -> master)
Author: User
Date:   Tue Apr 19 01:08:53 2022 -0400

    [PROJECT-100] - Added user profile module.

Remote commit

The following approach can be used to correct the latest pushed commit.

$ git commit --amend -m "[PROJECT-101] - Added user profile module."
 
And git log history will show the latest updated message as

commit 7e2937ff912a5c512036c9c1e4befb8a4512a9a3 (HEAD -> master)
Author: User
Date:   Tue Apr 19 01:08:53 2022 -0400

    [PROJECT-101] - Added user profile module.

However, because this change occurs in your current working directory, you must run the command below to update the remote repository.

$ git push --force origin master

When you look at the remote repository, you'll notice that the most recent message has been added to it.
 








Changing an Older or Multiple Commits

If you ever need to change multiple commits for some reason, use Git interactive rebase.

Git rebase rewrites the history, and it is strongly advised not to use rebase unless there is a compelling reason to use it.

Use the command git rebase -i HEAD~N, where N represents the number of commits to update.
As an example,

$ git rebase -i HEAD~3

It will launch an editor and allow you to choose three commits from the history.

pick 6bfbd01 Added Cucumber + Gradle project
pick 603981a Added Spring Boot SQL Logging project.
pick 7e2937f [PROJECT-101] - Added user profile module.

# Rebase 0d7b04f..7e2937f onto 0d7b04f (3 commands)

Navigate to the line you want to change and replace the pick word with the reword.

pick 6bfbd01 Added Cucumber + Gradle project
reword 603981a Added Spring Boot SQL Logging project.
reword 7e2937f [PROJECT-101] - Added user profile module.

Save and exit the editor now. For each reword commit, Git will launch a new editor.

[Project-99] Added Spring Boot SQL Logging project.

Save and exit the editor after updating the commit message.

This will bring your local git history up to date. Use the following command to update remote Git history.

$ git push --force origin master

It will update remote Git history as









Conclusion

Use the git commit --amend command to change the most recent commit message. Use git rebase -i HEAD~N to change older or multiple commit messages.

Don't change remote commits using rebase because it could cause a lot of problems for your colleagues.

Labels:

Comments

Post a Comment

Subscribe for latest tutorial updates

* indicates required

Popular posts from this blog

AJAX - How To Retrieve JSON Response from PHP script

By
Hello Friends, This is my first tutorial post. Today I'll explain you how to retrieve JSON response via Ajax call. First we build a PHP script to send response in JSON format, then we will gather this response from an Ajax call through jQuery script. Let’s first create a PHP script  Create a PHP script, I’ll name it as “json_response.php” And add following code in it json_response.php <?php //set header for JSON response header("Content-Type: application/json"); //render array in JSON format echo json_encode(array('status' => 200, 'message' => 'Response from PHP script in JSON format.')); This is a basic example to send JSON response. PHP script will send response with status code and message. Now create a HTML file to fetch JSON response and add it in header tag. Create a HTML file, I’ll name it as “json_response.html” And add following code. json_response.html <html>           ...
Post a Comment
Read more

Twig Tutorials: Install and Configure

By
In this tutorial, we'll look at how to install Twig within your PHP project and thereafter configure it so that we can create and use a Twig template inside our PHP web application. Later on, we'll see a simple Twig template example that displays a "Welcome to Twig template" message. Let's take it one step at a time. Install The Twig template can be installed using Composer, Git, or PEAR. In this tutorial, we will use Composer to install Twig. To do so, we'll need to make a "composer.json" file. { "require" : { "twig/twig" : "1.*" } } From the console, run the following command . $ php composer.phar install This command will install Twig library. Configuration To use the Twig template, we should first configure it. To achieve this, we will write an index.php file which will configure the Twig autoloader and generate the Twig environment. We will render the Twig temp...
Post a Comment
Read more

JAX-RS Tutorials: REST API using Java

By
JAX-RS is API specification   for RESTful web services using Java. RESTful web services is implementation of REST ( Representational State Transfer ) which is architectural design for distributed system or in general we can say JAX-RS  is a set of APIs to develop REST service.   This is a brief introduction about REST and JAX-RS. You can find more information on REST on Wiki and JAX-RS Official Site. What is REST? Representational state transfer is an abstraction of the architecture of the World Wide Web. More precisely, REST is an architectural style consisting of a coordinated set of architectural constraints (source  Wikipedia ) As JAX-RS is only a specification, we need to use it's implemented library to create RESTful web service. Following are such list of libraries Apache CXF , an open source  Web service  framework. Jersey , the reference implementation from  Sun  (now  Ora...
Post a Comment
Read more