|Version 4 (modified by mathieu, 5 years ago)|
- git mirror
- Mirorring process
- Services Pros & Cons
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 :
- on Mac :
- on Linux
- git : command line : sudo apt-get install git-core
- gitk : graphical local repository browser : sudo apt-get install gitk
- git-gui : A Tcl/Tk based graphical user interface to Git sudo apt-get install git-gui
What is git anyway ?
Also have a look at Why git is better than X
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.
~ $ git checkout git://github.com/openscenegraph/osg.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 http://github.com/openscenegraph/osg.git
~/OpenSceneGraph $ git pull
When planning to contribute to OpenSceneGraph you need to record your changes so they can be pulled into the upstream by the maintainer.
You will need a GitHub account
1. Fork the OpenSceneGraph project
Login to github. Go to http://github.com/openscenegraph/osg's git mirror project
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 firstname.lastname@example.org:[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 email@example.com:[your-github-account]/osg.git (fetch) origin firstname.lastname@example.org:[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://github.com/openscenegraph/osg.git
You should now have another remote :
~/osg (master)$ git remote -v origin email@example.com:[your-github-account]/osg.git (fetch) origin firstname.lastname@example.org:[your-github-account]/osg.git (push) upstream git://github.com/openscenegraph/osg.git (fetch) upstream git://github.com/openscenegraph/osg.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 master * 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.
~/osg (topic)$ git rebase master
7. Submitting your contribution
Work in Progress...
The mirorring process was fairly simple :
- use svn2git (my mirror added a --continue flag if the execution failed the svn fetch process) :
~ $ svn2git http://www.openscenegraph.org/svn/osg/OpenSceneGraph
- add remotes to push changes to
~/OpenSceneGraph (master)$ git remote add github email@example.com:openscenegraph/osg.git ~/OpenSceneGraph (master)$ git remote add gitorious firstname.lastname@example.org:openscenegraph/osg.git
- create a shell script osg-svn2git.sh to update and push changes
#!/bin/sh cd ~/OpenSceneGraph /usr/bin/git svn fetch /usr/bin/git merge trunk /usr/bin/git push --mirror gitorious /usr/bin/git push --mirror github
- add the shell script to the crontab
*/5 * * * * ~/osg-svn2git.sh
Services Pros & Cons
|downloads||+ source archive per tag||- manual upload of archives|