Skip to main content

The Dream of a Bi-directional Git-SVN mirror

This post is part of a series on Git and Subversion. To see all the related posts, screencasts and other resources, please click here

I just got an email asking me how one can set up a bi-directional Git-SVN mirror. It ended up being quite a long answer, so I'll post it here for the benefit of other Git-SVN readers with the same idea.

As you may know, I'm a proponent of my own Git-SVN setup.

I remember trying to go down the path of a bi-directional repository, but always ran into problems. Here is how it could work:




However nice this would be to have, it can be very hard to achieve in practice:

Git-svn requires working in a non-bare repository, so pushing to it is by default refused. You can work around this by doing this in the target sync repo:

git config receive.denyCurrentBranch ignore

You also have to automatically perform a git reset --hard in the syncing repo after each push (by some git hook?), because the work-dir is considered dirty when it is out of sync with the repository (a consequence of the previous workaround).

And now comes the really tricky part. Consider the following example:

  1. Bob commits change A in his local git repository, and pushes this to the sync repo.
  2. The sync repo does a git svn fetch (automatically to retain linear history).
  3. It then performs a dcommit, but in doing so, Bob's commit is re-written (with SVN meta data), therefore the commit changes into being .
  4. The central git repo dcommits the change to the SVN repo.

You see what has happened now? Bob's history has diverged from that of the sync repo:

Bob's history:    X <- Y <- Z <- A
Central history: X <- Y <- Z <- A´

So the next time Bob does a pull, Git will see that history has diverged, and automatically create a merge commit so Bob's history looks like this:
                               A
Bob's history: X <- Y <- Z <- /  \ <- merge commit
                              \  /
                               A´

You don't want this to happen, because next time Bob pushes, the merge commit will be dcommited, and so an evil circle is created.

You can avoid this by getting Bob to do a git pull --rebase, as Git (at least now when I tried it out) automagically figures out that A and are actually the same commit, and discards the former of them appropriately.

You still will have to deal with some other problems:

* Concurrency between commits - basically if somebody commits to SVN before the git repository has a time to sync a push from a git user, your syncing-repo gets messed up and needs to be manually reset (and probably the git pusher will have to repeat his push). This can get ugly, and it would happen relatively often in a busy repository.

* In case you have set up a physically split bare-repo and fetching-repo (like I've recommended on numerous occasions), the concurrency issues get slightly worsened, as you need to implement some locking mechanism across both repositories. Perhaps the best thing to do here is to go back to one single git/svn syncing-repo instead.

In summary:

  • Your developers will have to always do pull --rebase before and after pushing.
  • It has to be a low-traffic subversion repository, preferably all committers sitting co-located.
  • You have to be ready to dive in and fix any problems quickly (or have several people who can).

So, I hope you have enough information to properly consider whether this is worth going for. If you do, I would love to hear how it works out.

For the record: I do not recommend the bi-directional syncing repo approach. I still prefer my original setup where each developer is responsible for dcommitting back to Subversion. It's not so much more complicated for the Git users, and it is much safer, concurrency-wise.

Comments

  1. in your diagram above, does the "Sync repo" represent the "fetching repo" + "bare repo" setup that you mentioned in your other post?

    ReplyDelete
  2. Hi Joe,

    The diagram/setup is theoretical, but yes, I reckon that it would be a combined fetching - and central git repo. There would have to be a lot of hooks and locks to keep the repository in a correct state. I haven't given it too much thought.

    In the meantime, someone has actually come up with a product that has this capability:

    http://subgit.com/

    ReplyDelete
  3. have you tried subgit yet? i'm debating on whether or not i should follow your fetching-repo + bare-repo setup or give subgit a shot. wanted to get your opinion on subgit before i go down that path.

    ReplyDelete
  4. @joe: I gave Subgit a quick test on a tiny local svn-repo, and it worked great. As far as I can tell it's a working two-way mirror. (there is a list of known issues on their homepage)

    Still, Subgit hasn't been released yet, and I wouldn't latch the EAP version onto my main subversion repo before there's some guaranteed stability.

    Also the pricing is an important factor, of course. I have no idea how they're gonna price it.

    ReplyDelete
  5. That's how we do it: https://github.com/mrts/git-svn-bridge. But be sure to check out the caveats.

    ReplyDelete
  6. @mrts: Wow, that's really impressive! Well done :)

    ReplyDelete

Post a Comment

Popular posts from this blog

Open source CMS evaluations

I have now seen three more or less serious open source CMS reviews. First guy to hit the field was Matt Raible ( 1 2 3 4 ), ending up with Drupal , Joomla , Magnolia , OpenCms and MeshCMS being runner-ups. Then there is OpenAdvantage that tries out a handful ( Drupal , Exponent CMS , Lenya , Mambo , and Silva ), including Plone which they use for their own site (funny/annoying that the entire site has no RSS-feeds, nor is it possible to comment on the articles), following Matt's approach by exluding many CMS that seem not to fit the criteria. It is somewhat strange that OpenAdvantage cuts away Magnolia because it "Requires J2EE server; difficult to install and configure; more of a framework than CMS", and proceed to include Apache Lenya in the full evaluation. Magnolia does not require a J2EE server. It runs on Tomcat just like Lenya does (maybe it's an idea to bundle Magnolia with Jetty to make it seem more lightweight). I'm still sure that OpenAdvant

Encrypting and Decrypting with Spring

I was recently working with protecting some sensitive data in a typical Java application with a database underneath. We convert the data on its way out of the application using Spring Security Crypto Utilities . It "was decided" that we'd be doing AES with a key-length of 256 , and this just happens to be the kind of encryption Spring crypto does out of the box. Sweet! The big aber is that whatever JRE is running the application has to be patched with Oracle's JCE  in order to do 256 bits. It's a fascinating story , the short version being that U.S. companies are restricted from exporting various encryption algorithms to certain countries, and some countries are restricted from importing them. Once I had patched my JRE with the JCE, I found it fascinating how straight forward it was to encrypt and decrypt using the Spring Encryptors. So just for fun at the weekend, I threw together a little desktop app that will encrypt and decrypt stuff for the given password

The Git Users Mailing List

A year ago or so, I came across the Git-user mailing list (aka. "Git for human beings"). Over the year, I grew a little addicted to helping people out with their Git problems. When the new git-scm.com webpage launched , and the link to the mailing list had disappeared, I was quick to ask them to add it again . I think this mailing list fills an important hole in the Git community between: The Git developer mailing list git@vger.kernel.org  - which I find to be a bit too hard-core and scary for Git newbies. Besides, the Majordomo mailing list system is pretty archaic, and I personally can't stand browsing or searching in the Gmane archives. The IRC channel #git on Freenode, which is a bit out-of-reach for people who never experienced the glory days of IRC. Furthermore, when the channel is busy, it's a big pain to follow any discussion. StackOverflow questions tagged git , these come pretty close, but it's a bit hard to keep an overview of what questio

Git tools for keeping patches on top of moving upstreams

At work, we maintain patches for some pretty large open source repositories that regularly release new versions, forcing us to update our patches to match. So far, we've been using basic Git operations to transplant our modifications from one major version of the upstream to the next. Every time we make such a transplant, we simply squash together the modifications we made in the previous version, and land it as one big commit into the next version. Those who are used to very stringent keeping of Git history may wrinkle their nose at this, but it is a pragmatic choice. Maintaining modifications on top of the rapidly changing upstream is a lot of work, and so far we haven't had the opportunity to figure out a more clever way to do it. Nor have we really suffered any consequences of not having an easy to read history of our modifications - it's a relatively small amount of patches, after all. With a recent boost in team size, we may have that opportunity. Also the need for be

Managing dot-files with vcsh and myrepos

Say I want to get my dot-files out on a new computer. Here's what I do: # install vcsh & myrepos via apt/brew/etc vcsh clone https://github.com/tfnico/config-mr.git mr mr update Done! All dot-files are ready to use and in place. No deploy command, no linking up symlinks to the files . No checking/out in my entire home directory as a Git repository. Yet, all my dot-files are neatly kept in fine-grained repositories, and any changes I make are immediately ready to be committed: config-atom.git     -> ~/.atom/* config-mr.git     -> ~/.mrconfig     -> ~/.config/mr/* config-tmuxinator.git       -> ~/.tmuxinator/* config-vim.git     -> ~/.vimrc     -> ~/.vim/* config-bin.git        -> ~/bin/* config-git.git               -> ~/.gitconfig config-tmux.git       -> ~/.tmux.conf     config-zsh.git     -> ~/.zshrc How can this be? The key here is to use vcsh to keep track of your dot-files, and its partner myrepos/mr for o