I add a submodule from a git@... URL, to be able to develop in it. Now I want to deploy the app and replace the URL with an git://... one, so it doesn't need authentication to the submodule's repo from Capistrano. Is editing the URL in .gitmodules totally enough to accomplish this?
Editing the .gitmodules
file (then committing, and pushing it) will be adequate for any new clones.
Additionally, when a submodule is initialized (e.g. git submodule init …
, git submodule update --init …
, or git clone --recursive …
, etc.) its URL is copied from the .gitmodules
file to the repository’s .git/config
file.
So, if you have any existing “deployment clones” (the ones you now want to access the submodules through git://…
URLs), you will also have to update the URL in their .git/config
. You can use git submodule sync
to automatically copy the submodule URLs from the current .gitmodules
file to your .git/config
file (i.e. once you have pulled the commit that updates the .gitmodules
file).
The submodule URLs in .git/config
are not normally automatically updated because there are cases where you only want to override the URL in certain situations. Specifically, you will often want to use git@…
URLs in your repository’s .git/config
(so you can push over SSH), but put git://…
URLs in .gitmodules
(so that the general public does not need to do SSH-based authentication).