Difference between revisions of "Git"

Revision as of 05:07, 7 May 2010

Git mirrors of CVS repositories

The CVS repositories at Eclipse.org are being mirrored to read-only Git repositories. Please see the git repositories page for the full list of repositories. Please note that Git mirrors will be deleted for those projects that migrate to Git.

Git repositories

Eclipse projects may use either CVS, SVN or Git. The project you are looking for may not be using Git. Please see CVS_Howto and SVN_Howto for more information. If you are unsure which type of repository a project is using, please go to that project's home page.

My Eclipse project wants to use Git

• New projects may choose Git as their repository in the New Project Provisioning Request.
• Existing projects may migrate to Git from SVN or CVS. Please see Git/Migrating to Git for more details.

Migrating from CVS/SVN to Git

Please see Git/Migrating to Git.

Committers new to Git

Before working on a Git repository, please:

• Read Git for Dummies
• Have the Git Guide handy
• Note that anyone can commit to their repo, but only Eclipse committers can push their repo to git.eclipse.org
• DON'T FORGET to configure your git environment

   git config --global user.email my_committer_email@address.com
   git config --global user.name "John Doe"

List of Git repositories available

Please connect to http://git.eclipse.org/

Connecting, cloning a repo

Please see the list of Git repositories (above).

Committer access:

   git clone ssh://committer_id@git.eclipse.org/gitroot/project/repo

Anonymous, read-only access:

   git clone git://git.eclipse.org/gitroot/project/repo

Examples:

   git clone ssh://droy@git.eclipse.org/gitroot/babel/org.eclipse.babel.server.git
   git clone git://git.eclipse.org/gitroot/babel/org.eclipse.babel.server.git

Committing and pushing

The wrong way

The right way

Before committing code to your cloned repo, please ensure that your Git environment is properly set. Otherwise, the email address stored in the commit transaction in your repository will not match the email address of your Eclipse Committer record with the Eclipse Foundation, and your push will fail.

Setting up ssh keys

[This doesn't work unless you are a project lead.]

To avoid having to type in your password for each interaction with the server when using git from the command line:

• Generate a public/private key pair if you don't already have one on your own machine
• sftp committer_id@git.eclipse.org and transfer the id_xxx.pub files from your .ssh directory
• ssh committer_id@git.eclipse.org
• mkdir .ssh
• chmod 755 .ssh
• cd .ssh
• cat ../id_xxx.pub >>authorized_keys (for each .pub file you transferred)
• chmod 7ff authorized_keys

[At the moment, sftp is blocked, and using scp works, but you cannot run the mkdir command so cannot put the *.pub files into authorized_keys.]

Notes on DVCS

Due to our rigorous IP process, the Eclipse.org use-case for a DVCS is different than that of other Open Source organizations. For this reason, an update hook is installed on all Git repositories to ensure a clean IP provenance. For that reason, an update hook is installed and must remain in place on every Git repository.

The Eclipse update hook will examine the Committer entries of an incoming push. All the committer entries must be made by the committer performing the push, or the push will fail. Furthermore, your committer ID, or the committer email address registered with your committer account at the Eclipse Foundation must be present in the Committer Email record. Here are some scenarios to help understand this restriction:

   Scenario 1
   Jane Contributor is Author of code.  Commits to her local repo.
   Jane Contributer pushes (publishes) to a committer's local repo.
   Committer pushes code to git.eclipse.org will fail.  Committer cannot push code to us that they did not Commit.

   Scenario 2
   Jane Committer is Author of code. Commits to her local repo.
   Jane Committer pushes (publishes) to another committer's local repo.
   Committer pushes code to git.eclipse.org will fail.  Committer cannot push code to us that they did not commit (even if it is from another committer).

   Scenario 3
   Jane Committer, known as jane@bigcorp.com to the Eclipse Foundation, is Author of code. Commits to her local repo as jane@someisp.com.
   Jane Committer pushes code to git.eclipse.org will fail.  Eclipse.org does not recognize jane@someisp.com.

   Scenario 4
   Joe Contributor Authors code. Commits to his local repo.
   Joe Contributor attaches patch to Bugzilla.
   Committer applies patch to his local repo, commits to his local repo.
   Committer pushes code to git.eclipse.org will succeed.   Committer can push their committed code to us, preserving the Author information in the transaction.

Creating a new repository

Webmaster can create a new repository for you. Just open a bug against Eclipse Foundation > Community > Git. However, Eclipse committers with shell accounts can create new repositories:

   initrepo /gitroot/project/org.eclipse.repo.name.git

For consistency, the name of the repository must end with .git.

Permanently deleting code from Git

If you are required to permanently remove code from a Git repository, please open a bug against Community/Git and Webmaster will do this for you.