Version 3 (modified by mathieu, 4 years ago)

added worklows

git mirror

As of March 2010, an experiment in mirroring the svn source repository to git has been started. Information on how to use and contribute are listed below.


git, obviously :

  • on Windows :
    • test
  • on Mac :
    • gitx
  • on Linux
    • test


The mirror is hosted on github AND gitorious see comments at the end of this page on pros ans cons of these services

on github :
on gitorious :



This workflow is intended for users who need to stay on top of OpenSceneGraph activity but do not intend to modify it for they own need nor contribute some enhancements or bug correction back.

Initial checkout

~ $ git checkout git://

In case you are behind a restrictive firewall try opening TCP/IP port 9418 or use the http (slow) version as shown :

~ $ git checkout


~/OpenSceneGraph $ git pull


Contributor workflow

When planning to contribute to OpenSceneGraph you need to record your changes so they can be pulled into the upstream by the maintainer.

This is largely inspired from Michael Norton's blog entry Doc On Dev : 'Contributing to a project you find on GitHub'

You will need a GitHub account

1. Fork the OpenSceneGraph project

Login to github. Go to's git mirror project

To create a fork, press the "fork" button on the project's page.

When the fork is complete, you will have a copy of the project in your repositories listing.

2. Clone your project

Now back on your computer you need to clone your fork. Make sure you use the “Your Clone URL” and not the “Public Clone URL”. You want to be able to push changes back to your own repository.

~ $ git clone[your-github-account]/osg.git

Once the clone is complete your repo will have a remote named “origin” that points to your fork on github. You will use "origin" for your own regular activities.

~/osg (master)$ git remote -v
origin[your-github-account]/osg.git (fetch)
origin[your-github-account]/osg.git (push)

3. Link your repository to the upstream

repository that you forked

To keep track of the modifications committed to the 'upstream' branch of the project you need to add a remote branch to your local repository

~/osg (master)$ git remote add upstream git://

You should now have another remote :

~/osg (master)$ git remote -v
origin[your-github-account]/osg.git (fetch)
origin[your-github-account]/osg.git (push)
upstream        git:// (fetch)
upstream        git:// (push)

4. Create a branch containing your contribution

First step is to create a branch to make your modifications. Lets call it topic :

~/osg (master)$ (master)> git checkout -b topic
Switched to a new branch 'topic'
~/osg (topic)$ git branch
* topic

Now make your modifications to the project and commit them to your topic branch.

5. Keep your fork up-to-date

Forking a repository is the recommended way of contributing to a github project. Alas it doesn't get updated with the latest commits from the forked repository.

The upstream remote we added in the previous topic will help you update your repository with those latest changes by pulling and then merging in them in as so :

~/osg (master)$ git pull upstream master

Now your local upstream/master should contain all the new commits. You can merge them to your master branch.

~/osg (master)$ git merge upstream/master

6. Keep your contributions up-to-date

When updating your repository with the upstreams modifications it is likely that your topic branch will need to integrate those changes too. This is called rebasing. This will modify your topic branch commits (yes, it will create some new commits) to make the topic branch start from the latest commits in the upstream repository. The illustrations are taken from the Git Community Book, origin -> master and mywork -> topic in our case.

before :

~/osg (topic)$ git rebase master

after :


Mirorring process

The mirorring process was fairly simple :

  1. use svn2git (my mirror added a --continue flag if the execution failed the svn fetch process) :
    ~ $ svn2git
  2. add remotes to push changes to
    ~/OpenSceneGraph (master)$ git remote add github
    ~/OpenSceneGraph (master)$ git remote add gitorious
  3. create a shell script to update and push changes
    cd ~/OpenSceneGraph
    /usr/bin/git svn fetch
    /usr/bin/git merge trunk
    /usr/bin/git push --mirror gitorious
    /usr/bin/git push --mirror github
  4. add the shell script to the crontab
    */5 * * * * ~/

Services Pros & Cons

github gitorious
downloads + source archive per tag - manual upload of archives