FAQ Récupérer, mettre à jours les sources GIT du projet

Voici les informations sur comment récuperer et travailler avec les sources du projet Dolibarr.

=Recevoir la dernière version des sources par téléchargement = Cette méthode vous permet de recevoir les sources de la branche de développement principale (Appelée HEAD). Cette opération consiste à récupérer la dernière version des fichiers de l'application Dolibarr qui sont compilées chaque nuit dans un fichier tgz. Ce fichier est disponible par le lien suivant:

Les nouveaux fichiers écrasent les anciens. Le problème de cette méthode est qu'il faut télécharger et décompresser chaque fois le paquet dès que l'on souhaite recevoir des mises à jour.

=Recevoir la dernière version des sources en utilisant un accès anonyme GIT.=

Prérequis
Premièrement, vous devez avoir une installation fonctionnelle de Eclipse. Le plugin EGit doit aussi être installé. Pour l'installer, utilisez Help depuis le menu Eclipse puis cliquez sur Install new softwareet cliquez sur Available software site. Dans la liste des adresses qui apparait, recherchez le lien : http://download.eclipse.org/egit/updates Puis, choisissez d'installer EGit.

Pour récuperer les sources dans l'intention de les modifier, vous avez besoin d'un compte GitHub, et un client GIT (Les outils GIT en ligne de commande Linux, ou le client GIT d'Eclipse).

Processus de Clone
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, choose "Clone GIT repository". Enter GIT URL of project to get.

First setup your git client: Then clone repository locally: And, if you are behind a firewall, you can user the alternate URL:
 * With GIT on Command Line Interface:

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, go into GIT view - Branches - Local. In most cases, the branch you choosed should be already available.

If not: If you choose "Create Branch", this will duplicate content of branch to work on it locally. If you Choose "Checkout", this will update the view "Working Directory". This will create local branch and make checkout automatically.
 * With Eclipse, right click on "Branches - Remotes - The branch you want to duplicate locally".
 * With GIT on Command Line Interface;

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.



=Récupérer la dernière version des sources avec un accès GIT complet=

Prérequis
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.

Processus de clone
Le processus est le même que pour récupérer les sources de manière anonyme (voir ci-dessus), seule l'URL d'accès change.

URL à utiliser pour le clonage GIT:

Noter que une URL HTTP est aussi disponible mais est parfois hors service (aussi prenez de préférence la méthode précédente):

=Mettre à jour votre 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:

= Ajout un commit exterieur dans votre repository courant = 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 with Eclipse:
 * 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

=Résoudre un conflit= 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:
 * With Eclipse, right click on project top line and select "Reset" then "Hard" then "Reference - HEAD".
 * Using GIT command line tool, you can achieve this with command

=Tagguer les sources= Avec les outils en Ligne de Commande GIT:

Pour créer un tag sur une version:

Pour supprimer un tag:

=Créer une nouvelle branche= Voici la commande à utiliser pour créer une nouvelle branche depuis un repository propre develop:

=Statistiques= Avec les outils en Ligne de Commande GIT:

Pour compter le nombre de changerment qu'un développeur a fait entre une version x et y:
 * First, run git merge-base to know the id of last common commit between x and y
 * 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 change finally found if changes were ok at first try):
 * Use same method than previously but instead of running git log, run git diff.

Plus d'information sur l'utilisation de GIT disponible ici.