We use Git submodules to maintain our internal and external plugin dependencies. New to submodules? Here are a couple articles to get you started:
In a nutshell, Git submodules let us keep standalone projects in separate Git repos. These projects are then loaded into our theme via submodules, typically in the lib directory. The theme repo only knows of the submodule based on the submodule URL and its committed hash.
If you aren't actively working on a plugin submoduled into our theme, you probably shouldn't be committing Git submodule hash changes. You can make sure you're on the proper hash for your branch by running git submodule update.
From time to time, especially if we have a lot of changes we might forget to not commit the SHA1. If you do already, here's the step to roll back before the PR can be merged.
- You would see something like this.
which you don't want it to happen in your PR.
-
So to rollback the hash you need to go into the directory of that submodule and do
git checkout 1dba7d7ad049c06ffc7a35a6d65d4ff4098a5fcd(according to the example above) which will checkout the previous version of the submodule. -
Then you can commit the change in your main directory that contains the submodule you just rolled back.
git add -A; git commit -m "advance submodule to previous revision". -
Then you can push the change
git push origin <your branch name>
The best thing to avoid is to do git submodule update before anything is committed.
-
You can do checkout and update submodule in the same time.
git pull origin master && git submodule update -
You can ignore the whole submodule directory by doing this
git update-index --assume-unchanged <the directory you want to ignore>/* -
You can create custom shell function to checkout a branch and update submodules in the same time
function go {
git checkout $1 && git submodule update
}
So when you want to checkout a branch you can just do go master
Unfortunetely, there's no way to do this in Github for OsX. You have to do this manually.
All of this just some examples that you can do to avoid the headache. The most important thing is to pay attention to what you are committing but if you made a mistake which we are all then you can roll back by the steps above.