Skip to main content
Jump to: navigation, search

Orion/Releng Builds

< Orion
Revision as of 15:30, 7 April 2014 by (Talk | contribs) (How it works)

Orion currently has 3 kinds of builds:

  • The PDE build uses infrastructure from Eclipse platform releng. As of March 2014, the PDE build is deprecated, and will be removed shortly. See bug 414425 for info.
  • The Tycho build is based on Tycho and Maven. Compared to the PDE build, the Tycho build is easier for downstream products to consume, and easier to reproduce in other environments.
  • The Node build is a small script that runs on Node.js. It produces an Orion server that runs under Node.js.

How to contribute

This section applies to all builds.

Contributing changes to the build

Contributing to a build is easy: just commit your code to the master stream of the Orion repository and it will be included in the next integration build.

Setting up your workspace

  1. See Orion/Getting the source for instructions on how to set up your workspace to work with Orion source code.
  2. (If you want to try running the PDE build locally): Import 'org.eclipse.orion.releng' into your workspace. It is located in the org.eclipse.orion.server.git repository under the releng folder.

Contributing your changes

Once you have made code changes, you can contribute them to the Integration build as follows:

  • Commit your changes to the local repository and push them to the master
git commit -a -m "fix lots of bugs"                   #commits all changes
git push                                              #push local commits to the master


The Orion build performs optimization of client pages and plugins using RequireJS. Note the distinction between optimization (inlining a module's AMD dependencies to reduce HTTP overhead) and minification (shrinking a module's JavaScript code size by removing whitespace). The build minifies all JavaScript code automatically, but getting your module optimized requires an extra step. This section has instructions on how to add new content for optimization in the build.

Adding a new module to the optimization

To add a new page or plugin for optimization, you must update this file: releng/org.eclipse.orion.client.releng/builder/scripts/ Find the property modules, and add an entry for your page/plugin.

Every entry needs a name property giving the module's web path. For example, here is the Git Commit page's entry:

    { name: "git/git-commit" },

The PDE, Tycho, and Node builds all share, so your new module will be correctly built everywhere.

Adding a new client bundle to the JS build

  1. Add an entry to the bundles section of (Ant-style property replacement is supported within the bundles entry, but ${orionClient} is the only property you should use there.)
  2. If your bundle contains any JSDocs, add an entry to the jsdocs section of
  3. For each of the bundle's modules you want to optimize, add an entry to the modules section of (see previous section).
  4. Add a pom.xml file in the root folder of your bundle.
  5. Add an entry to the <modules> section of the client repo's top-level pom.xml. This ensures that the Maven builder finds your bundle.

Building stand-alone features

Orion pages and plugins are handled by a multi-module invocation of r.js that optimizes all of them in one shot. However, stand-alone features need different build config options, which means r.js must be invoked separately for each of these features.

To build a stand-alone feature, you must add logic to the requirejs task in the Ant script You must invoke r.js, passing the build file for your feature. Here is an example showing how a file used for the standalone Orion editor is minified:

  1.  <!-- Clean widget output directory -->
  2.  <target name="widgetClean" depends="widget.check" if="">
  3.     <delete dir="${widgetOutDirectory}" />
  4.     <mkdir dir="${widgetOutDirectory}" />
  6.     <copy file="${builder}/scripts/" tofile="${staging}/" overwrite="true"/>
  7.     <!-- ... -->
  8.  </target>
  10.  <target name="requirejs" depends="checkDirs, cleanStaging, cleanOptimized">
  11.      <!-- ... -->
  13.      <!-- build standalone editor (unless skipEditor is set) -->
  14.      <antcall target="editorOptimize">
  15.          <param name="staging" value="${staging}" />
  16.          <param name="out" value="${widgetOutDirectory}" />
  17.      </antcall>
  19.      <!-- ... -->
  20.  </target>
  22.  <target name="editorOptimize" unless="skipEditor">
  23.      <sequential>
  24.          <!-- Invoke r.js -->
  25.          <widgetOptimizeFile
  26.             out="${out}/built-editor-amd.min.js"
  27.             buildfile="${staging}/"
  28.             optimize="closure"
  29.             staging="${staging}" />
  31.          <!-- Additional calls to r.js can be placed here, if neede -->
  32.      </sequential>
  33.  </target>

PDE build

The PDE builds follow many of the same practices used by the Eclipse Platform Project. The builds are based on PDE/Build and run automatically on via cron job.

There is only one kind of build. Integration builds run daily from tagged repository versions. Map files are used to specify where a project is located in the repository and what version of that project to use in the build. The map files are located in the org.eclipse.orion.releng project. The builder itself performs the tagging so all the latest changes in "master" stream are picked up by every build. No manual tagging by committers is required.

How the build works


The build is kicked off by a "bootstrap" script that is not under version control. The only purpose of this script is to fetch the real build script and invoke the build. The script is located at:


The build type is passed as an argument. -I means integration build (with tagging). -N is equivalent but does not perform any tagging (in both cases the contents of master are used to perform the build).

You can also pass an -email argument to cause the build notifications to only be sent to an individual. This is useful for test builds: -I -email

The bootstrap script is typically invoked by a cron entry in the e4Build user account. For example here is a cron entry to start a build every Wednesday at 8:55am:

55 08 * * Wed /opt/buildhomes/e4Build/ -I

Invoke "crontab -e" to edit the cron entries (using vi), or "crontab -l" to simply list them.

The bootstrap fetches and invokes the main build script, called This script is under version control, so you need to push any changes to this script into the master branch for them to take effect. If you scroll to the very bottom of this script you can see the steps it performs:

tagRepositories # perform auto-tagging of the Orion git repositories
updateRelengProject # fetch latest from Orion releng project (our scripts and maps)
updateBaseBuilder # fetch the PDE builder to use in the build
setProperties # various initialization steps
runBuild # invoke the PDE build
runTests # invoke client and server tests
publish # send results email

build log

The results of the build, including any failures from any step, can found found in the build log at:


This is the first place to check when the build fails. It is typically very long so it is often helpful to use tail to start near the end. This exact same log gets copied into the download directory so it is available for reference for any build we produce. For example:


Repository cache

For performance reasons, PDE build maintains a cache of fetched prerequisite bundles. This lives at /shared/eclipse/e4/orion/target/transformedRepos on the build machine. The build will pick up the newest version of each required bundle from that location. If you ever need to force the build to go back to an *older* version of a bundle, this cache needs to be cleared. Simply delete the transformedRepos directory prior to the build.

Deploying builds to or

Builds are deployed using the script This script should be copied to your home directory and run from there. Your home directory will contain a symlink to the downloads directory, so you can perform a deploy directly from the downloads area. The script takes a single argument which is the location of the zip containing the download. For our servers we want the Linux 64-bit build. It is useful to log the output of this script so it can be reviewed later. Example:

./ -archive downloads/orion/drops/I201201102230/ >> deploy.log

This script simply copies the build onto the deployment server, and invokes an upgrade script on that server - The upgrade script shuts down the old server, moves it, unzips and configures the new build, and finally starts it.

The entire deploy/upgrade process takes about 5 seconds when it runs smoothly. Occasionally there will be a communication error copying the new build onto the target machine. In this case simply re-running the script usually succeeds.

Server configuration

The server configuration file on and is found in ~admin/current/orion.conf. This file gets copied into the server by the deployment script. So, any change made to this configuration file will take effect only on the next deployment.

Tycho build

The Tycho builds use the Eclipse Tycho infrastructure (Category:Tycho), centered around Maven. Orion committers can managed Tycho builds using the Orion Hudson instance. The build comprises 2 jobs:

Builds Orion's client-side JavaScript code and performs JS minification.
Downstream project of orion-client. Builds Orion's Java server and runs the tests.

As of this writing, Tycho builds only run Orion's Java server tests; Orion's JavaScript tests are not yet supported.

Node build

The Node build is a Grunt script that produces a self-contained, Node.js-based Orion server with optimized client-side JavaScript code.

The script runs automatically before Orion is published to the npm repository, but it can be run manually as well. The Orion dev team publishes builds on a regular basis, at least once per milestone.

Running the Node build script

First, you should also install grunt globally:

npm install -g grunt

Then ensure you have the dev dependencies the Orion Node server needs:

$ cd modules/orionode
$ npm install

To run the build, simply run grunt from the orionode folder:

$ cd modules/orionode
$ grunt

< lots of output >

Done, without errors.

When the script finishes, modules/orionode contains a complete optimized server suitable for publishing to npm. Running node server.js as normal will launch the optimized server.

To produce a standalone optimized tarball of Orion, use the npm pack command:

$ npm pack

> orion@0.0.27 prepublish .
> grunt

< lots of output >

Done, without errors.

How it works

The script copies all the client code from the top-level bundles/ folder of the Orion client repo into modules/orionode/orion.client/bundles. The code is then "staged" (i.e. the runtime web-path structure is recreated on disk) to a temp directory, and RequireJS optimization is performed. After optimization, minified code and source maps are copied back into the bundle folders that they originated from. The end result is a self-contained directory.

To build a customized Orion server, edit Gruntfile.js. You can supply an alternative path to the Orion client code, or a different RequireJS build configuration (take care to maintain the Orion "shape", however: for example your build config must have a bundles property).

Back to the top