Git

From BaseX Documentation
Revision as of 17:24, 12 September 2011 by CG (talk | contribs) (moved GIT to Git)
Jump to navigation Jump to search

Using Git to contribute to BaseX

Our team uses git and GitHub to manage the source code.

All team members have read+write access to the repository, external contributors are invited to fork the project.

Git makes it easy to retain a full copy of the repository for yourself. To get started and running, simply fork BaseX. If forking sounds unfamiliar to you, we suggest to look up some of the documentation listed at the end of this page.

You can then build BaseX with Maven. Using Eclipse is optional.

Using Git & Eclipse

  1. (Optional) Head over to https://github.com/BaseXdb and create an account
  2. Fork BaseX, so you have a version on your own
  3. Make yourself familiar with git (see the end of this page)
  4. Install egit (Eclipse: HelpMarketplace → Search for egit or get it from http://www.eclipse.org/egit/)
  5. Open Eclipse

Setup

Git01.png
In the Package Explorer to the left use right-click and choose Import...
Git02.png
Select "Projects from Git" and click Next >

Clone

Git03.png
Click "Clone..." to create a local copy of the remote repository. This copy will include the full project history
Git04.png
Copy & Paste the github URI in the Location field. If you want to use SSH make sure you provided GitHub with your public key to allow write-access. If in doubt use the HTTPS URI and authenticate yourself with your GitHub credentials.
Git05.png
Select the master branch (or arbitrary branches you like)
Git06.png
Now choose a location where the local repository is stored: Create <workspace>/repos/BaseX

and click "Finish".

Create the project

Git07.png
Select our newly cloned repository and click Next
Git08.png
Select "Import Existing Projects" and depending on your Eclipse version enable automatic sharing. More recent versions will not offer this feature as sharing is enabled by default.

Click next to select the Project to import

Git09.png
Check "basex" to checkout and click finish
Git10.png
You are now ready to contribute.

EGit & SSH

EGit uses the JSch library which is, however, reported to have problems with RSA SSH keys in linux and possibly other platforms. A solution would be to use the variable GIT_SSH and assign it a path to the native SSH executable. According to this change in EGit, the plugin will try to use a native SSH implementation instead of JSch (this, however, may not always work either :( ).

Using Git on Command-Line

Note: this is not intended to be a complete git reference; it's purpose is to quickly introduce BaseX developers to the most commonly used git commands in the context of the BaseX project.

Preparation

  1. Create a GitHub user account: here (your github user name will be referenced as $username)
  2. Set up SSH access to GitHub as described here
  3. Create a fork of one of the BaseXdb projects (it will be referenced as $project)
  4. Choose a directory where the project will be created and make it your working directory (e. g. /home/user/myprojects)

Clone Your Personal Repository

$ pwd
/home/user/myprojects

$ git clone git@github.com:$username/$project.git
Cloning into $project...
Enter passphrase for key '/home/user/.ssh/id_rsa': 
remote: Counting objects: 61445, done.
remote: Compressing objects: 100% (10611/10611), done.
remote: Total 61445 (delta 45273), reused 61131 (delta 44975)
Receiving objects: 100% (61445/61445), 49.95 MiB | 1.83 MiB/s, done.
Resolving deltas: 100% (45273/45273), done.

$ ls -d -1 $PWD/*
/home/user/myprojects/$project

Note that git automatically creates a directory where the repository content will be checked out.

List Remote Repositories

$ git remote -v
origin  git@github.com:$username/$project.git (fetch)
origin  git@github.com:$username/$project.git (push)

Currently, there is only one remote repository; it is automatically registered during the clone operation. Git remembers this repository as the default repository for push/pull operations.

List Local Changes

After some files have been changed locally, the changes can be seen as follows:

$ git diff
diff --git a/readme.txt b/readme.txt
index fabaeaa..cd09568 100644
--- a/readme.txt
+++ b/readme.txt
@@ -49,6 +49,10 @@ ADDING CHECKSTYLE --------------------------------------------------------------
  - Enter the URL: http://eclipse-cs.sourceforge.net/update
  - Follow the installation procedure and restart Eclipse
 
+USING GIT ----------------------------------------------------------------------
+
+TODO
+
 --------------------------------------------------------------------------------
 
  Any kind of feedback is welcome; please check out the online documentation at

Commit to Local Repository

Note: this commit operation does not commit into the remote repository!

First, it is needed to select the modified files which should be committed:

$ git add readme.txt

Then perform the actual commit:

$ git commit
[master 0fde1fb] Added TODO in section "USING GIT"
 1 files changed, 4 insertions(+), 0 deletions(-)

Before executing the actual commit, git will open the default shell editor (determined using the $EDITOR variable, usually vi) to enter a message describing the commit changes.

Alternative way is to commit all changed files, i. e. it is not needed to add explicitly the changed files:

$ git commit -a
[master 0fde1fb] Added TODO in section "USING GIT"
 1 files changed, 4 insertions(+), 0 deletions(-)

Pushing Local Changes to Personal Repository

$ git push
Enter passphrase for key '/home/user/.ssh/id_rsa': 
Everything up-to-date

Pulling Changes from Personal Repository

$ git pull
Enter passphrase for key '/home/user/.ssh/id_rsa': 
Already up-to-date.

Add BaseXdb Upstream Repository

The upstream repository is the one from which the BaseX releases are made and the one from which the personal repository was forked.

$ git remote add upstream git@github.com:BaseXdb/$project.git

$ git remote -v
origin  git@github.com:$username/$project.git (fetch)
origin  git@github.com:$username/$project.git (push)
upstream        git@github.com:BaseXdb/$project.git (fetch)
upstream        git@github.com:BaseXdb/$project.git (push)

Pulling Changes from Upstream Repository to Local Repository

When some changes are made in the upstream repository, they can be pulled to the local repository as follows:

$ git pull upstream master
Enter passphrase for key '/home/user/.ssh/id_rsa': 
From github.com:BaseXdb/$project
 * branch            master     -> FETCH_HEAD
Already up-to-date.

The changes can then be pushed in the personal repository:

$ git push

Check out the links at the end of the page for more git options.

Need help using git?

Installing

For information on how to install git on various platforms please refer to: GitHub: git Installation Guide

Documentation