git-add doesn't seem to work on submodules

[kgadek]

It seems that index.add doesn't work with submodules. Found exactly same issue/question on stackoverflow.

Reproduction

First, some shell:

git init master_repo
cd master_repo
echo "First" > progress_simulator
git add progress_simulator
git commit -m 'First commit'
git submodule add -b master [email protected]:gitpython-developers/GitPython.git subrepo
git commit -m 'Second commit: subrepo'

Now, the Python:

import git
master_repo = git.Repo('.')
[subrepo_sm] = master_repo.submodules
subrepo = git.Repo(subrepo_sm.path)
with open('subrepo/interference.txt', 'w'): pass
subrepo.index.add(['interference.txt'])
subrepo.index.commit('My intrusion into this project')
master_repo.index.add([subrepo_sm])

Expected vs result

I expected to see master_repo index acknowledge that the subrepo submodule pointer changed. However, nothing happens.

System info

$ python -V
Python 3.4.3

$ git --version
git version 2.4.2

[Byron]

Thanks for the awesome issue ! I wished all of them would be made that thoroughly !

Even though I am working on figuring out the GitPython way, one should always be able to use git directly such as in master_repo.git.add(subrepo_sm.path), which will add the submodule correctly. Now one will be able to commit the staged changes.

I shall keep you posted.

[Byron]

There now is a new test which shows how to do it in a pythonic fashion. The stackoverflow question was answered showing the mentioned way, and a slightly simpler one.

Both ways show that a change in GitPython is not required, even though adding changed submodules to the index seems a bit more difficult/involved than one might hope when using GitPython directly.

[kgadek]

Thanks! I'll look at it tomorrow :)

[Byron]

That's a good idea ! Apparently the approach only works in py2.6 - travis fails in all other versions. It's ... odd.

[Byron]

Ok, just a bug in the test - I think chances are travis will confirm this is fixed now.

[Byron]

You can watch the development stream on youtube.

GitPython #19 [issue 335 - how to add submodules to the index]