How to build

Dependencies

• Eclipse IDE for Eclipse Committers, see https://www.eclipse.org/downloads/packages/eclipse-ide-eclipse-committers/neon1
• Maven: just install the m2e plugin, see https://www.eclipse.org/m2e
• Tycho: do not need separate installation, will be fetched by Maven during the build automattically, see https://eclipse.org/tycho/

Get eclox plugin sources

• clone eclox
  • from https://github.com/anb0s/eclox.git to new directory eclox OR
  • fork the project at GitHub and clone your forked repository
• switch to master branch and create new branch for your fix
• Import all projects to Eclipse and add them to new "Working Set" eclox
  • eclox: root project, needed only for readme, headless build with travis etc.
  • eclox.branding: branding project
  • eclox.core: the eclox core code
  • eclox.doxygen.core: the eclox core for doxygen binaries
  • eclox.doxygen.feature: the eclox feature for doxygen binaries
  • eclox.doxygen.platform: the eclox platform definition for doxygen binaries
  • eclox.doxygen.releng: the eclox release engineering for doxygen binaries
  • eclox.doxygen.root: the eclox build-root for doxygen binaries
  • eclox.doxygen.site: the eclox update site for doxygen binaries
  • eclox.feature: the eclox feature
  • eclox.help: the eclox help
  • eclox.platform: the eclox platform definition
  • eclox.releng: the eclox release engineering
  • eclox.root: the eclox build-root for doxygen binaries
  • eclox.site: the eclox update site
  • eclox.ui: the eclox UI code

Running and debugging in Eclipse

• select target platform you want to test eclox against:
  • go to project eclox.platform
  • open wanted platform definition file, e.g. for Eclipse 4.6 Neon use Eclipse-4.6.target
  • use Set as Target Platform and wait until the platform defition is loaded from Eclipse mirrors
• now there should be no build errors anymore
• use Run | Debug As | Eclipse Application and wait until the new Eclipse instance is opened
• use eclox, set breakpoint etc. :)

Building eclox plugin with update site for testing

• go to project eclox.root
• build
  • from Eclipse: run launch configuration Eclox-Testing-Build
  • from commandline / headless / CI server: mvn clean verify with parameter site.dir=testing
• go to project eclox.site and use one of:
  • directory target\repository OR
  • zip file e.g. target\org.gna.eclox.site-0.12.0-SNAPSHOT.zip OR
  • last version from updates\testing

Contributing to main project

• push your branch to your forked repository
• create a pull request for the pushed branch
• write clear commit comments and describe your pull request (e.g. what was fixed and contributed, reference the issue number etc.)

For Maintainers

Building eclox plugin with update site for releasing

• go to project eclox.root
• build
  • from Eclipse: run launch configuration Eclox-Release-Build
  • from commandline / headless / CI server: mvn clean verify with parameter site.dir=release
• go to project eclox.site and use one of:
  • directory target\repository OR
  • zip file e.g. target\org.gna.eclox.site-0.12.0-SNAPSHOT.zip OR
  • last version from directory updates\release

Get eclox web-site (gh-pages)

• clone eclox from
  • https://github.com/anb0s/eclox.git OR
  • your forked repository to new directory eclox-gh-pages
• switch to gh-pages branch
• Import the project to Eclipse and add it to "Wortking Set" eclox
  • eclox-gh-pages: root project, needed for web- and update-site

Deploy new versions

• for testing
  • synchronize the directory updates\testing to project eclox-gh-pages directory testing
  • commit and push project eclox-gh-pages to GitHub and check the new version from site http://anb0s.github.io/eclox/testing
• for releasing
  • synchronize the directory updates\release to project eclox-gh-pages directory release
  • commit and push project eclox-gh-pages to GitHub and check the new version from site http://anb0s.github.io/eclox