FAQ Get,update GIT project sources

This is informations on how you can get sources of Dolibarr project. Several methods are described, but we recommandusing the one based on GitHub.

=Get last version of sources by tgz download= This method can be used by non technical users. It allows you to get sources of main development branch (called HEAD) by just downloading a file: This operation consist to get last version of Dolibarr files that are packaged each night into a tgz file. File is available with link:

New files overwrite old ones. The inconvenient of this method is that you must download and uncompress package each time you want to get updates.

=Get last version of sources using a GIT anonymous access=

Prerequisite
First you must have a working install of Eclipse. EGit plugin must also have been installed. For this, use the Find And Install process into Eclipse menu, add the GIT update URL: http://download.eclipse.org/egit/updates Then choose to install EGit.

To get sources with goal to edit them, you need a GitHub write access to the GIT remote repository, and a GIT client (GIT command line tool with Linux, or the GIT client in Eclipse). See next chapter for this.

Clone process
First, enter value of the repository with reference sources into your GIT client tool.

GIT Url for Dolibarr official source is: Your Eclipse GIT client will ask you to choose the branches you are interesting in. Branches not selected now could be selected later by doing a "Fetch" from the "Remotes" view, but try to choose only the branch you need. This will save you time and problems later.
 * With Eclipse, go into perspective GIT, click onto button "Clone GIT repository". Enter GIT URL of project to get.

Note: if you are behind a firewall, you must set Eclipse proxy credentials into Eclipse menu Windows - Preferences - General - Network connection and use the alternative URL:

First setup your git client: Then clone repository locally:
 * With GIT on Command Line Interface:

Note: if you are behind a firewall, you must set your porxy information and use the alternative https URL:

Once this step is validated, your GIT client will download all files from remote GIT server. This may last several seconds or minutes.

Once download is finished, you must choose which branch to us to work on.

This will create local branch and make checkout automatically. Choose "Create Branch" (and check the box "Checkout"). This will duplicate content of branch to work on it locally and will refresh your "Working Directory" to work on this branch.
 * With GIT on Command Line Interface;
 * With Eclipse, right click on "Branches - Remotes - The branch you want to duplicate locally".

Create Eclipse project:

If using Eclipse, once your branch is created locally, create a PHP project from assistant by choosing "Create from existing project" and select directory that is your GIT local repository (Do not choose to create a PHP project from scratch). Then right click on project from your Eclipse workspace and Choose "Team - Share". Select GIT and click on option "Use or create repository in parent folder of project". An alternate method is File->Import, Git->Project from Git, Select the Git repository and Next, Use New project Wizard -> Php project, enter the folder of you GIT local repository.

Then, you can setup Eclipse to avoid it to scan all project files for its build tools (Outline scanner, TODO scanner, syntax scanner...). This will avoid Eclipse to be too slow. For this, right click on project, choose Build Path and setup it like into following screenshot.



=Get last version of sources using a GitHub user access=

Prerequisite
First you must have a working install of Eclipse. EGit plugin must also have been installed. For this, use the Find And Install process into Eclipse menu, add the GIT update URL: http://download.eclipse.org/egit/updates Then choose to install EGit.

You must before create an account on GitHub (https://github.com/) and upload a public RSA or DSA certificate into your account profile.

Clone process
Then process is same than getting sources with anonymous access.

URL to use for GIT clone is same:

Note that a HTTP URL is also available but it's sometimes offline (so prefer using first one, it is required only if you are behind a firewall):

=Update your repository= To update your local workspace, right click on Eclipse project and select "Pull".

If you made some changes into your Eclipse workspace on files that were changed into the GIT remote reference, your GIT client will make a merge automatically.
 * If there is conflicts, the merge will mark all conflict files as "conflict" (See later to solve this state).
 * If not, you will get all new version files including all your changes.

If you already have commited some files into your local repository, your workspace will be marked as "Merged". All you have to do is make a commit to validate your local repository as including your changes and changes made by others.

= Commit and publish your changes = To see all changes you made into your working directory and waiting to be added into Git:
 * With GIT Command Line Interface:

To add changes made into your local repository into the GIT index, then commit this index : This will save add and changes into your local branch.
 * With Eclipse: Right click on file or directory to commit. Select file to add/remove/update into commit.
 * With GIT Command Line Interface:

To push them on the GIT repository server,
 * With Eclipse: right click on project and choose "Team - Push to Upstream".
 * With GIT Command Line Interface:

To cancel a commit:


 * With GIT Command Line Interface, if commit was not already pushed:
 * With GIT Command Line Interface, if commit was already pushed:

= Add an external commit into current repository = Some developers may work and do commit into their own Git repository after forking the project. If you are interesting into getting this changes, you can import them with the following steps.

You need both Eclipse and GIT Command Line interface to achieve this:
 * First, go into GIT setup view and right click on "Remotes" of your Eclipse Git working space and choose "Create a remote..."
 * Type name or remote fork the developer has create (in most cases, it's developer Git login). For example: "thedevlogin". Choose also "Configure Fetch".
 * Type URI of Git repository of developer. For example: git://github.com/thedevlogin/dolibarr.git. Also add a refspec value to declare the branch you want to get. For example: refs/heads/master:refs/remotes/thedevlogin/master. Click "Save and Fetch". A new entry will be added into "Remote Tracking" making possible to read/get commits done into this branch.

Now, go on command line of your git repository (in most cases on Linux, it's /home/yourlogin/git/yourdolibarr) and type the git cherry-pick command: where commitid is value of commit id you want to get.

Once this is done, go back to Eclipse and make a refresh on project. You will see modified files appears with decorators (with conflicts if there is).

It the cherry-pick fails because of conflicts, you can cancel the cherry-pick try with

=Solving a conflict= If a file has been marked as "conflict" after a Pull request, open the file to edit it. Find string "<<<<<<<<<<", you will see part of code that is conflict between "<<<<<<<<<" and ">>>>>>>>". Edit manually code lines and remove "<<<<<<<<" and ">>>>>>>".

Then, right click on file and select "Add".

If you prefer to forget completely all changes you made into all files (so to restore you workspace with content of remote repository), you can make a hard reset: To reset changes you commited but not pushed to origin
 * With Eclipse: Right click on project top line and select "Reset" then "Hard" then "Reference - HEAD".
 * With GIT Command Line Interface: You can achieve this with command

=Tagging sources= With GIT Command Line Interface:

To add a tag to a current version:

To remove a tag:

=Creating a new branch= With GIT Command Line Interface:

Create a clone (see previously) of the branch from where you want to create another branch, then go into directory and launch command:

With Eclipse:

Create a clone (see previously) of the branch from where you want to create another branch, with a checkout done. The go into view git. Choose branches, remote tracking and select start branch. Right click and choose "Create branch". Then make a push to create branch remotely. Then go into "Remotes - origins" and edit the entries to pull and push onto new branch. It may also be required to edit the .git/config file to have project linked by default onto new branch.

= Deleting a branch= With GIT Command Line Interface:

Do a push on branch but add : before name of branch:

=Merging a maintenance branch x.x into dev branch= With Eclipse:
 * Go onto the root directory of project with a checkout of the dev branch.
 * Check fetch setup to be sure, this repository contains both information of dev branch and version x.x you want to merge.
 * Right click onto root directory and choose "Team - Merge". Select "x.x". Click onto "Merge options - Commit", because we want to commit merged branch if there is no conflicts.
 * Once merge is done, check everything is ok.
 * Commit and push.

= Pushing a branch onto another Git server = You may want to synchronize another GIT server. To synchronize push to another server, this is how to proceed. With Eclipse:
 * Go onto Git clone view and add a remote with a name, choose "Configure push" and enter URL. For example, for name "sourceforge" and URL "ssh://yoursourceforgelogin@git.code.sf.net/p/dolibarr/code"
 * Just validate, a first push will be done automatically.
 * To force sync, run

=Statistics= With GIT Command Line interface:

To count number of changes developers have made between a version x and y: To find id_start To find id_end, choose among Choose a value for id_start and id_end Note: id_end can be HEAD.
 * First, search commit id of tags you want to compare
 * Then run git log to have list of all changes from last common commit to last commit
 * To get total number of added/deleted lines:

To count number of changes finally between a version x and y (it differs from previous count because in previous count, a change can be done 2 times at two different moment to change differently. With second method, you count changes finally found if changes were ok at first try).
 * Use same method than previously but instead of running git log, run git diff.

More information in GIT usage is available here.