Differentiating Commit Messages for Git Hook Merge Commits

Differentiating Commit Messages: Git Hook for Merge Commits

When working with Git, it is essential to write clear and descriptive commit messages to help other developers understand the changes made. This need becomes even more critical when dealing with merge commits. Merge commits usually contain multiple changes from different branches, and a well-crafted commit message can help unravel the complexity of these changes. To ensure that your merge commits have specific information, you can use a Git hook named "commit-msg".

What is a Git Hook?

Git hooks are scripts that Git executes before or after events such as committing or pushing. These scripts are stored in the .git/hooks directory of every Git repository. You can use these scripts to enforce or customize various aspects of your Git workflow. For example, you can use a pre-commit hook to lint your code or run tests before allowing the commit. In this article, we will focus on using a commit-msg hook to validate commit messages for merge commits.

Why Validate Commit Messages?

Validating commit messages is essential for maintaining a clean and understandable commit history. When you enforce a consistent format for commit messages, you can quickly glance through the history to understand the changes that were made. Moreover, it becomes easier to generate reports and statistics based on the commit data. By validating commit messages for merge commits, you ensure that the changes from multiple branches are clearly explained, making it easier for other developers to understand and track the evolution of the project.

Implementing a Git Hook for Merge Commits

To implement a commit-msg hook for merge commits, follow these steps:

1. Navigate to the .git/hooks directory of your Git repository.
2. Create a new file named "commit-msg.sample" and rename it to "commit-msg" (remove the ".sample" extension).
3. Edit the new file, and add the following code:

 #!/bin/sh
 #
 # An example Git hooks script to validate commit messages for merge commits.
 #

 # Only check merge commits
 if [ "$3" != "merge" ]; then
 exit 0
 fi

 # Extract the JIRA ticket ID from the commit message
 COMMIT_MSG_JIRA_ID=$(grep -Eo '[\w]+-[\d]+' <<< "$1")

 # Exit immediately if the commit message doesn't contain a JIRA ticket ID
 if [ -z "$COMMIT_MSG_JIRA_ID" ]; then
 echo "Error: Commit message must contain a JIRA ticket ID for a merge commit."
 echo "Hint: Make sure to include a JIRA ticket ID in the format 'ABC-123'."
 exit 1
 fi

 # If the validation succeeds, exit with no error
 exit 0
 

This script checks whether the commit is a merge commit using the "$3" variable provided by Git. If the commit is a merge commit, it extracts the JIRA ticket ID from the commit message using the grep command. If the commit message doesn't contain a JIRA ticket ID, it prints an error message and exits with a non-zero error code. If the validation succeeds, the script exits with no error.

Enforcing the Git Hook

To enforce the commit-msg hook, you need to make sure it's executable by running the following command:

 chmod +x .git/hooks/commit-msg
 

Now, whenever you commit changes using the "git commit" command, the commit-msg hook will check the commit message and enforce the validation. If the validation fails, Git will prevent the commit and print the error message.

Summary and References

In this article, we have learned about Git hooks and how to implement a commit-msg hook to validate commit messages for merge commits. By enforcing specific information in commit messages, we can maintain a clean and understandable commit history, improve the maintainability of our projects, and ease collaboration with other developers. Here are some references for further reading:

• Customizing Git: Git Hooks
• Merging with pull requests