Versions Compared

Old Version 13

changes.mady.by.user Julien Carsique

Saved on

compared with

New Version Current

changes.mady.by.user Julien Carsique

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Column
Panel
bgColor#FFFFFF
titleOn this page
Table of Contents

Getting Nuxeo Platform

...

source code

Nuxeo core developers should have a look at Nuxeo's Git usage.

...

Note

The following assumes you know how to work with Maven and sources in your IDE (Eclipse is used below). In particular this means that you have already configured the IDE to work with Maven (M2_REPO set in Eclipse).

Nuxeo requires Maven 2.2.1 (not 3.x).

Getting the development branch

Code Block
titleClone in Read-Only mode

git clone git://github.com/nuxeo/nuxeo.git
cd nuxeo
git checkout master
python clone.py
Code Block
titleClone in Read+Write mode

git clone git@github.com:nuxeo/nuxeo.git
cd nuxeo
git checkout master
python clone.py
Note
  • clone.py can be run with Python 2.7.x but not 3.x versions.
  • Users of MSysGit should run clone.py with option --no_drive_mapping or -n as MSysGit is not able to access dynamically mounted drives. This option is available as of version 5.7
Note

Contributing to Nuxeo does not require cloning Nuxeo source code: see Contributing to Nuxeo

...

Code Block
titleFull build Nuxeo without running tests

mvn -Dmaven.test.skip=true export MAVEN_OPTS="-Xmx1g -XX:MaxPermSize=128m"
mvn -DskipTests install -Paddons

If you want to open/edit the projects in Eclipse do the following at the very root of the Git repository:

Code Block
titleGenerate Eclipse's project files

# "downloadSources" and "downloadJavadocs" are optional parameters, set to false by default
mvn eclipse:clean eclipse:eclipse -Paddons,distrib,all-distributions [-DdownloadSources=true] [-DdownloadJavadocs=true]
# Linux and OS X users should then run the following script to make Eclipse use different build directories than Maven:
./fixeclipse
# Since Nuxeo 5.7, a cross-platform script is available for Windows users:
python scripts/fixeclipse.py

Then in Eclipse:

Code Block
titleImport Nuxeo modules into Eclipse

File -> Import -> General -> Existing Projects into Workspace

...

Code Block
titleGet Nuxeo 5.5 release source code

python clone.py release-5.5

...

Code Block
titleUpdate sources

python clone.py

Useful Shell functions

...

Code Block
titleUse Nuxeo helper Shell scripts

echo ". $PWD/scripts/gitfunctions.sh" >> ~/.bashrc

...

Code Block
titleGit script "gitf" usage

gitf status
gitf describe --all

# Also recurse on "standard" addons (those listed in addons/pom.xml)
gitfa [some Git command]

...

SCM Branch

SCM Tag

Version

Status

master

 

x.y.z-SNAPSHOT

development branch where is prepared next x.y.z version

5.5.0

 

5.5.0-HFXX-SNAPSHOT

maintenance branch where bugs are fixed/backported for Nuxeo 5.5

 

release-5.5

5.5

release tag for 5.5 version

5.4.2

 

5.4.2-HFXX-SNAPSHOT

maintenance branch where bugs are fixed/backported for Nuxeo 5.4.2

 

release-5.4.2

5.4.2

release tag for 5.4.2 version

fix-NXP-9999-*
feature-NXP-9999-*

 

usually same as on master

development branch dedicated to NXP-9999 feature or bug fix

...