administrator, editor
1
edit
Changes
Jump to navigation
Jump to search
All team members have read+write access Git makes it easy to retain a full copy of the repositoryfor yourself. To get started and running, external contributors are invitedto simply ''fork the project. '' BaseX:
Git makes it easy # Head over to retain a full copy of the repository for yourselfhttps://github. To get started com and runningcreate an account# Fork https://github.com/BaseXdb/basex, simply fork BaseX.If forking sounds unfamiliar to so you, we suggest to look up some of the documentation listed at the end of this page.have a version on your own You # The forked project can then build BaseX with [[Maven]]. Using Eclipse is optional.be cloned on your local machine, and changes can be pushed back to your remote repository
# (Optional) Head over to https://github.com/BaseXdb and create an account
# Fork BaseX, so you have a version on your own
# Make yourself familiar with git (see the end of this page)
# Open Eclipse
# Install egit (Eclipse: ''Help'' → ''Marketplace'' → Search for ''egit'' '''or''' get it from http://www.eclipse.org/egit/)
<table cellspacing='0' cellpadding='0'>
<tr><td valign='top'>
[[File:Git01.png|border|300px|left]]
[[File:Git02.png|border|300px|left]]
[[File:Git03.png|border|300px|left]]
[[File:Git04.png|border|300px|left]]
[[File:Git05.png|border|300px|left]]
[[File:Git06.png|border|300px|left]]
[[File:Git07.png|border|300px|left]]
[[File:Git08.png|border|300px|left]]
[[File:Git09.png|border|300px|left]]
[[File:Git10.png|border|300px|left]]
</td><td width='20'>
</td><td valign='top'>
EGit The Eclipse git plugin uses the [http://www.jcraft.com/jsch / JSch] library , which is, however, had [https://bugs.eclipse.org/bugs/show_bug.cgi?id=326526 reported] to have problems with RSA SSH keys ] in linux Linux and possibly other platforms. A solution would be to use If the problem persists, the variable GIT_SSH and assign it a path to the native SSH executable. According can be assigned to [http://egit.eclipse.org/r/#change,2037 this] change in EGit, the plugin will try to use a native SSH implementation instead of JSch (this, however, may not always work either :( ){{Code|GIT_SSH}} variable.
===Installing===You can now click the "Compare & pull request" button. You can now review the changes you are going to push.
For information on how to install git on various platforms '''Please review them carefully. Also, please refer give a meaningful comment so we can quickly determine what your changes are doing.''' After clicking the "Create Pull request" button you are done and we will review your changes and either merge the pull request or get back to: [http://help.githubyou.com/git-installation-redirect/ GitHub: git Installation Guide]
no edit summary
This page is part of the [[Developer Section]]. It describes how to use [https://git-scm.com/ git] to manage the BaseX sources.
==Using Git to contribute to BaseX ==
Our team uses git and [https://github.com GitHub] to manage the source code. All team members have read/write access to the repository, and external contributors are welcome to fork the project.
==Using Git & Eclipse==
===Clone===
* In the '''Package Explorer''' to the left , use right-click and choose '''Import...'''* Select "'''Projects from Git'''" and click '''Next >'''* Click "Choose the '''Clone...'''" option to create a local copy of the remote repository. This copy will include the full project history* Copy & Paste the github 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 https URI and authenticate yourself with your GitHub credentials. The read-only URI of the repository is {{Code|https://github.com/BaseXdb/basex.git}}.
* Select the master branch (or arbitrary branches you like)
* Now choose a location where the local repository is stored: Create <workspace>'''/repos/BaseX''' and click "'''Finish'''".
<gallery>
File:Git01.png|Package Explorer
File:Git02.png|Projects from Git
File:Git03.png|Clone
File:Git04.png|GitHub URI
File:Git05.png|Select Branch
File:Git06.png|Location
</gallery>
===Create the project ===
* 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
* Check "basex" to checkout check out and click finish
* You are now ready to contribute.
<gallery>
File:Git07.png|Select Repository
File:Git08.png|Import existing Projects
File:Git09.png|Select basex Project
</gallery>
===EGit & SSH===
==Using Git on Command-Line==
'''Note''': this is not intended to be a complete git reference; it's its purpose is to quickly introduce BaseX developers to the most commonly used git commands in the context of the BaseX project.
===Preparation===
# Create a GitHub user account: [https://github.com/signup/free here] (your github user name will be referenced as $username)
# Set up SSH access to GitHub as described [httphttps://helpdocs.github.com/keyen/github/authenticating-to-github/connecting-to-github-setupwith-redirect ssh here]
# Create a fork of one of the BaseXdb projects (it will be referenced as $project)
# Choose a directory where the project will be created and make it your working directory (e. g. /home/user/myprojects)
===Clone Your Personal Repository===
<pre classsyntaxhighlight lang="brush:shell">
$ git clone git@github.com:$username/$project.git
Cloning into $project...
$ ls -d -1 $PWD/*
/home/user/myprojects/$project
</presyntaxhighlight>
Note that git automatically creates a directory where the repository content will be checked out.
===List Remote Repositories===
<pre classsyntaxhighlight lang="brush:shell">
$ git remote -v
origin git@github.com:$username/$project.git (fetch)
origin git@github.com:$username/$project.git (push)
</presyntaxhighlight>
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.
After some files have been changed locally, the changes can be seen as follows:
<pre classsyntaxhighlight lang="brush:shell">
$ git diff
diff --git a/readme.txt b/readme.txt
Any kind of feedback is welcome; please check out the online documentation at
</presyntaxhighlight>
===Commit to Local Repository===
First, it is needed to select the modified files which should be committed:
<pre classsyntaxhighlight lang="brush:shell">
$ git add readme.txt
</presyntaxhighlight>
Then perform the actual commit:
<pre classsyntaxhighlight lang="brush:shell">
$ git commit
[master 0fde1fb] Added TODO in section "USING GIT"
1 files changed, 4 insertions(+), 0 deletions(-)
</presyntaxhighlight>
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 explicitly add explicitly the changed files:<pre classsyntaxhighlight lang="brush:shell">
$ git commit -a
[master 0fde1fb] Added TODO in section "USING GIT"
1 files changed, 4 insertions(+), 0 deletions(-)
</presyntaxhighlight>
===Pushing Local Changes to Personal Remote Repository===
<pre classsyntaxhighlight lang="brush:shell">
$ git push
Enter passphrase for key '/home/user/.ssh/id_rsa':
Everything up-to-date
</presyntaxhighlight>
===Pulling Changes from Personal Remote Repository===
<pre classsyntaxhighlight lang="brush:shell">
$ git pull
Enter passphrase for key '/home/user/.ssh/id_rsa':
Already up-to-date.
</presyntaxhighlight>
===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.
<pre classsyntaxhighlight lang="brush:shell">
$ git remote add upstream git@github.com:BaseXdb/$project.git
upstream git@github.com:BaseXdb/$project.git (fetch)
upstream git@github.com:BaseXdb/$project.git (push)
</presyntaxhighlight>
===Pulling Changes from Upstream to Local Repository===
When some changes are made in the upstream repository, they can be pulled to the local repository as follows:
<pre classsyntaxhighlight lang="brush:shell">
$ git pull upstream master
Enter passphrase for key '/home/user/.ssh/id_rsa':
* branch master -> FETCH_HEAD
Already up-to-date.
</presyntaxhighlight>
The changes can then be pushed in the personal repository:
<pre classsyntaxhighlight lang="brush:shell">
$ git push
</presyntaxhighlight>
Check out the links at the end of the page for more git options.
</td></tr></table>
==Need help =Developing a new feature or bug fix=== It is always a good idea to create a new branch for a new feature or a big fix you are working on. So first, let's make sure you have the most up-to-date source code. We assume, that you added BaseX as upstream repository as described above and you are currently in the ''master'' branch: <syntaxhighlight lang="shell">$ git pull upstream master</syntaxhighlight> Now, we create a new branch, based on the master branch <syntaxhighlight lang="shell">$ git checkout -b new-featureSwitched to a new branch 'new-feature'</syntaxhighlight> Your are now automatically switched to the ''new-feature'' branch. Now you can make all your changes in one or several commits. You can commit all changes using <syntaxhighlight lang="shell">$ git?=commit -a</syntaxhighlight> Now, you want to push these changes to the repository on GitHub. Remember, that up to now your changes just reside on your local drive, so now you want to push it to your remote fork of BaseX. Simply do: <syntaxhighlight lang="shell">$ git push origin new-featureCounting objects: 318, done.Delta compression using up to 4 threads.Compressing objects: 100% (107/107), done.Writing objects: 100% (154/154), 22.96 KiB | 0 bytes/s, done.Total 154 (delta 93), reused 81 (delta 26)To git@github.com:$username/basex.git * [new branch] new-feature -> new-feature</syntaxhighlight> You can now use your web browser and go to your fork of BaseX. You will see the following message: [[File:Git11.png]]
===Documentation=Links==
* [httphttps://docs.github.com/en/github/getting-started-with-github/set-up-git GitHub: git Installation Guide]* [https://help.github.com/ Comprehensive Getting Starting Guide on GitHub]* [httphttps://book.git-scm.com/index.html The git book]* [http://gitcasts.com/ Gitcasts.com – Video Guides]
