Building WOLips

Version 125.1 by mark_ritchie on 2009/08/30 14:08

Prior to building WOLips, you will want to get your dependencies installed properly.  Check out the Installing WOLips page for information on the dependencies for WOLips.

WOLips is now located in Subversion at objectstyle.org.  The CVS repository at sourceforge is now deprecated.

The subversion repository path is https://svn.objectstyle.org/repos/woproject

Prerequisites

Install Subclipse (the Subversion plugins)

  1. Help=>Software Updates=>Find and Install ...
  2. Add New Remote Site
    1. Name = Subclipse
    2. URL = http://subclipse.tigris.org/update_1.0.x
  3. Select the site, select all the plugins available, and install them

Install the m2eclipse plugin (Eclipse 3.5 instructions)

  1. Help -> Install New Software
  2. Click "Add..."
    1. Name = M2Eclipse
    2. Location = http://m2eclipse.sonatype.org/update/
    3. Click "OK"
  3. Expand "Maven Integration"
  4. Select "Maven Embedder"
  5. Select "Maven Integration for Eclipse"
  6. Click "Next>"
  7. Click "Finish"

Checking out and Building from the Commandline

  1. Checkout the trunk/woproject folder from Subversion
    svn co https://svn.objectstyle.org/repos/woproject/trunk .
  2. cd woproject
  3. ant
  4. The first build will fail out telling you that it couldn't find wobuild.properties -- That's OK
  5. Edit /Library/wobuild.properties
  6. Add a line: eclipse.home=/path/to/your/eclipse
  7. ant again and it should succeed this time
    1. If you get the error 'build.xml:73: taskdef A class needed by class org.apache.velocity.anakia.AnakiaTask cannot be found: org/jdom/JDOMException', you can do one of two things.  You can build with -Dno.docs=true to skip the javadoc step, or (untested) you can drop jdom-b8.jar from woproject/projects/lib into your ANTHOME/lib folder.
  8. The build went into temp/dist
  9. Profit
  10. Installing WOLips

Checking out and Building inside of Eclipse for Deployment

  1. Add the wolips SVN repository https://svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
  2. In SVN perspective, browse WOLips repository on HEAD, checkout trunk/woproject
  3. Right-click (or equiv) on the build.xml inside of the "woproject" project and Run As=>Ant Build ...
  4. Switch to the Properties tab and check for the definition of eclipse.home in the Properties list
  5. If eclipse.home does not exist, uncheck "Use global properties" and then click "Add Property"
  6. In the Add Property dialog, make the name eclipse.home, click Add Variable, select eclipsehome from the list, and click OK
  7. Click Apply to save your changes
  8. Run
  9. Once it is complete, you may need to right-click=>refresh your project and you will have a temp/dist folder with the plugin site in it.
  10. Installing WOLips

Checking out and Building inside of Eclipse for Development (PDE)

  1. Add the wolips SVN repository https://svn.objectstyle.org/repos/woproject in the SVN Perspective's Repository View
  2. You can select individual plugins you would like to work on by browsing to trunk/woproject/wolips/ in the Subversion repository and checking out the plugins you are interested in. To checkout complete sets of plugins, you could also use the Eclipse Team Project Set.

An approach to setting up the development and test environment for WOLips Plugin.

In order to do WOLips Plugin development you will need two eclipse environments:  Development and Test.

  1. Follow the Checking out and Building inside of Eclipse for Deployment in you primary Eclipse installation (i.e. /Application/eclipse) and workspace.  This will be you development environment.
  2. the temp/dist folder is your Local Site for the Test Environment.
  3. Create a second copy of "clean" Eclipse under /Users/<me>/Developer/eclipse (this could be any where).  This will be your Test Environment.
  4. In the test environment, follow the Installing WOLips instructions, using your temp/dist directory as the Local Site.  Install the plugins.
  5. Use the Test environment to exercise/test the changes from your locally modified Plugin.
  1. When you need to repeat the process, shut down the Test Environment, delete the org.objectstyle. files in the features and plugins directories under the /Users/<me>/Developer/eclipse directory.  Change the source code in the primary environment and build. (Each build took 3 min 37+ seconds on my Mac Book Pro 17").  Once the build is done, then reinstall the plugin in the Test Environment.  The Local Site should still be selected.

Building WOLips with Hudson Continuous Build server

Hudson is a Java base continuous build server that allows you to build and test your project automatically. It can be easily configured to build WOLips in a few simple steps.

  1. Add a new job with the following configuration
      Project Name: WOLips
      Subversion: http://svn.objectstyle.org/repos/woproject/trunk/woproject
      Local module directory (optional): wolips
      Use update: Checked
      Poll SCM: 59 *  *   (59 can be replaced with any number between 0 and 59)
  2. Add the following build tasks to the job
Execute Shell

echo build.version=3.4.${SVN_REVISION} > wolips/build.properties
echo eclipse.home=/usr/local/eclipse >> wolips/build.properties
echo user.home=${WORKSPACE} >> wolips/build.properties
Invoke Ant

Targets: dist

If you want to deploy the build to a web server to serve as an update site add a task that is something like this

Execute Shell

rm -fr  /usr/local/www/apache22/data/wolips/*
/bin/cp -prv ${WORKSPACE}/wolips/temp/dist/ /usr/local/www/apache22/data/wolips/
  1. Copy eclipse with the necessary plugins installed to your build server. In this example it has been copied to /usr/local/eclipse
    The currently required plugins for a deployment build are

    • JProfiler
    • m2Eclipse Maven