Skip to content

Git pre-commit hook to check the sanity of submodules before commit

License

Notifications You must be signed in to change notification settings

rodrigo-lima/submodule_checker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Git Submodule Check

Introduction

When working with git submodules the worst part is dealing with missed commits. That usually happens when you make changes to the submodule, but forget to push it to its remote repository before merging/pushing the parent repository.

There are many posts regarding this

pre-commit hook

The goal of this script is to help avoid this issue by comparing the local commits for each submodule against their corresponding commits on the remotes. If there's a mismatch, then the commit is aborted.

Installation

Copy this pre-commit script to .git/hooks folder on the repository you want to monitor. Now, everytime you try to commit the parent repository, the script will run and check the commit SHAs for each submodule to make sure you have the latest copy and you did not miss any push.

Sample Outputs

If all goes well, this is what you should see and commit will succeed:

user@mac ~/Work/MyClonedRepo (master)$ git commit -am "pushing parent and submodule is good" 
Checking submodules...
  Submodule [Vendor/lib_1] ... OK
  Submodule [Vendor/lib_2] ... OK
  Submodule [Vendor/lib_3] ... OK
returning state 0
[master 73ba08d] pushing parent and submodule is good
 1 file changed, 1 insertion(+)
user@mac ~/Work/MyClonedRepo (master)$ 

Otherwise, an error message is displayed and it lists the SHAs to help you resolve the issues:

user@mac ~/Work/MyClonedRepo (master)$ git commit -am "pushing parent and submodule is wrong"
Checking submodules...
  Submodule [Library/SampleLib] ... FAILED
 
Stop! Pre-commit condition failed.
Did you forget to push submodule [Library/SampleLib] to remote?
Cannot proceed until you do so.
Remote HASH: 12f8c095710278aadf18f04e3ca026ac7cdd7e72
Local HASH.: 3281d051f138bcd8c48d431ecdbdc54c2c6987db

user@mac ~/Work/MyClonedRepo (master)$ 

Notes

  • Script was tested with Mavericks 10.9.2
  • submodules of submodules are not checked

About

Git pre-commit hook to check the sanity of submodules before commit

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages