Skip to content

How To Build

Jump to bottom
Xyrio edited this page Mar 22, 2018 · 15 revisions

for the console build you can just download maven and compile from console and use whatever ide you like.

or you can use eclipse to run it directly from eclipse and also build using eclipse PDE system (graphical) but also using maven (m2e) which is already integrated as a plugin in eclipse-ee.

we skip running all tests for now as some fail because they need to be improved to work without external websites (which changed) and a failure would stop the build process.

  1. download latest jdk 8 like from here: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

  2. download source code from https://github.com/Xyrio/RSSOwlnix either using git or as zip.

  3. if you intend to use eclipse make sure you have another dirtyable parent folder for the eclipse workspace like: C:\rssowlnixprj\RSSOwlnix\README.md

  4. note: macos binaries seem to have the wrong folder/file structure, look at how 2.2.1 is packaged or the bundle_b for later releases as to how the folder/file structure should be. ( https://github.com/Xyrio/RSSOwlnix/issues/4 )

(optional) do this if you want to use eclipse

  1. download latest Eclipse IDE for Java EE Developers: https://www.eclipse.org/downloads/eclipse-packages/
  2. start eclipse and use C:\rssowlnixprj\ as your workspace folder.

(optional) install plugins in eclipse for additional functionality

from Help/Install new Software... choose the url that is for updates like: http://download.eclipse.org/eclipse/updates/4.7

  1. (optional) install plugin in eclipse "Eclipse PDE Plug-in" to be able to run directly from eclipse for testing purposes (file: Launch RSSOwl.launch )
  2. (optional) install plugin in eclipse "Eclipse Test Framework" to be able to run tests direclty from eclipse

Console (very easy)

build from console using maven then run standalone

  1. download maven binaries: https://maven.apache.org/download.cgi
  2. add maven's bin folder to your path or use absolute path to mvn
  3. you must set JAVA_HOME environment variable to point to your JDK root folder like C:\Program Files\Java\jdk1.8.0_161
  4. open console in RSSOwlnix root folder
  5. compile with: mvn clean verify -Dmaven.test.skip=true
  6. you can build only for certain operating systems if you edit RSSOwlnix\releng\configuration\pom.xml environments
  7. binaries can be found inside RSSOwlnix\releng\product\target\products
  8. p2 repository for updating is at RSSOwlnix\releng\product\target\repsitory

Eclipse

in eclipse you have 2 ways to build, using maven or with eclipse's PDE build system.

Configuring Eclipse

menu: Window/Preferences/Java/Installed JREs

  1. remove the entry (jre...)
  2. click add...
  3. Standard VM
  4. set JRE home to like: C:\Program Files\Java\jdk1.8.0_161
  5. check jdk
  6. Apply and Close

Adding source code to eclipse

  1. File/Import.../General/Existing Project Into Workspace...
  2. directory: C:\rssowlnixprj\RSSOwlnix\
  3. check Search for nested projects
  4. finish with all checked

Maven (m2e) (easy)

  1. first time setup: in file tree on the left open RSSOwlnix folder and right click pom.xml then Run As/Maven build...
  2. Goals: clean verify -Dmaven.test.skip=true
  3. Apply then Run
  4. to build again click the downward triangle right of the biggest green play icon then RSSOwlnix.
  5. you can build only for certain operating systems if you edit RSSOwlnix\releng\configuration\pom.xml environments
  6. binaries can be found inside RSSOwlnix\releng\product\target\products
  7. p2 repository is at RSSOwlnix\releng\product\target\repsitory

Eclipse PDE build system (not so easy)

Target Platform

  1. open RSSOwlnix\releng\target_platform\target_platform.target (every time you show the target_platform like this it will do a refresh of the view, showing you the selected dependencies)
  2. at top right, click to set as active target platform (only visible if not aktive platform)
  3. click reload target platform (or changes to the dependencies will not be available sometimes. they are cached somewhere)
  4. close the target platform window

Exporting Product

  1. open RSSOwlnix\releng\product_manual_export\rssowlnix.product
  2. at top right click on the icon for "Export an Eclipse Product"
  3. Root directory: RSSOwlnix
  4. Synchronize before exporting: off
  5. Directory:
  6. Generate p2 repository: on (repository cannot be used to update RSSOwlnix itself when exported like this but is needed for RSSOwlnix to be built correct)
  7. Export for multiple platforms: check this for an aditional step (Next button enables) ...
  8. Allow for binary cycles in target platform: on
  9. click Finish (or Next if you enabled export for multiple platforms)
  10. note: a exported version like this is not updateable, you have to export again. addons and translations can be installed.

Run from Eclipse

  1. TODO

Run a Test from Eclipse

  1. TODO
Clone this wiki locally