Difference between revisions of "VTK/Git"

From KitwarePublic
< VTK
Jump to navigationJump to search
Line 46: Line 46:
  
 
Authorized developers may publish work directly to <code>vtk.org/vtk-tmp.git</code> using Git's SSH protocol.
 
Authorized developers may publish work directly to <code>vtk.org/vtk-tmp.git</code> using Git's SSH protocol.
 +
 +
Note that ''we may not grant all contributors push access'' to the <code>vtk.org</code> repository.
 +
The distributed nature of Git allows contributors to retain authorship credit even if they do not publish changes directly.
 +
'''After the final conversion to Git''' is finished we will consider pull requests from online Git hosting sites.
  
 
==Authentication==
 
==Authentication==
Line 62: Line 66:
 
To request access, fill out the [https://www.kitware.com/Admin/SendPassword.cgi Kitware Password] form.
 
To request access, fill out the [https://www.kitware.com/Admin/SendPassword.cgi Kitware Password] form.
 
Include your ssh public key, '''<code>id_rsa.pub</code>''', and a reference to someone our administrators may contact to verify your privileges.
 
Include your ssh public key, '''<code>id_rsa.pub</code>''', and a reference to someone our administrators may contact to verify your privileges.
 
Note that ''we may not grant all contributors push access'' to the <code>vtk.org</code> repository.
 
The distributed nature of Git allows contributors to retain authorship credit even if they do not publish changes directly.
 
'''After the final conversion to Git''' is finished we will consider pull requests from online Git hosting sites.
 
  
 
==Pushing==
 
==Pushing==

Revision as of 14:24, 29 March 2010

VTK version tracking and development will be hosted by Git.

Experimental Repository

We have published an experimental repository on vtk.org. WE REQUEST THAT NO ONE PUBLISH A CLONE OF THIS REPOSITORY AT AN ONLINE HOSTING SITE. This may or may not be the final version of history after conversion from CVS. It may be removed or rewritten at any time. We prefer to not have multiple incompatible histories out there. The final conversion will be available soon, at which point we may all begin sharing changes!

One may browse the repository online using the Gitweb interface at http://vtk.org/vtk-tmp.git.

At the time of this writing the repository does not have branches and tags older than VTK 5.0. Conversion of older branches and tags from CVS will be completed later and added.

Cloning

One may clone the repository using git clone through the native git protocol:

$ git clone git://vtk.org/vtk-tmp.git VTK

or through the (less efficient) http protocol:

$ git clone http://vtk.org/vtk-tmp.git VTK

All further commands work inside the local copy of the repository created by the clone:

$ cd VTK


Development

We provide here a brief introduction to development with Git. See the Resources below for further information.

First, use git config to introduce yourself to Git:

$ git config --global user.name "Your Name"
$ git config --global user.email "you@yourdomain.com"

Optionally enable color output from Git commands:

$ git config --global color.ui auto

The --global option stores the configuration settings in ~/.gitconfig in your home directory so that they apply to all repositories.

Publishing

Authorized developers may publish work directly to vtk.org/vtk-tmp.git using Git's SSH protocol.

Note that we may not grant all contributors push access to the vtk.org repository. The distributed nature of Git allows contributors to retain authorship credit even if they do not publish changes directly. After the final conversion to Git is finished we will consider pull requests from online Git hosting sites.

Authentication

All publishers share the git@vtk.org account but each uses a unique ssh key for authentication. If you do not have a public/private ssh key pair, generate one:

$ ssh-keygen -C 'you@yourdomain.com'
Generating public/private rsa key pair.
Enter file in which to save the key ($HOME/.ssh/id_rsa):
Enter passphrase (empty for no passphrase): (use-a-passphrase!!)
Enter same passphrase again: (use-same-passphrase!!)
Your identification has been saved in $HOME/.ssh/id_rsa.
Your public key has been saved in $HOME/.ssh/id_rsa.pub.

To request access, fill out the Kitware Password form. Include your ssh public key, id_rsa.pub, and a reference to someone our administrators may contact to verify your privileges.

Pushing

Git automatically configures a new clone to refer to its origin through a remote called origin. Initially one may fetch or pull changes from origin, but may not push changes to it.

In order to publish new commits in the vtk.org repository, developers must configure a push URL for the origin. Use git config to specify an ssh-protocol URL:

$ git config remote.origin.pushurl git@vtk.org:vtk-tmp.git

(Note that 'pushurl' requires Git >= 1.6.4. Use just 'url' for Git < 1.6.4.)

Once your push URL is configured and your key is installed for git@vtk.org then you can try pushing changes.

Feel free to push anything to the experimental vtk-tmp.git repository. Note however that it is not official and all changes will be thrown away before publishing the official repository.

Resources

Additional information about Git may be obtained at these sites: