Activiti Developers Guide
Building the sources
JDK 5+ : Make sure that you do not use code constructs that require JDK 6 or higher.
Running tests before commit
Before a checkin is done, a developers should make sure to update to the latest sources and then run
mvn -Pcheck clean install
in the root activiti directory
To run smoke tests on webapps, the quickest way to get started is using the target test.demo.setup in qa/build.xml
That will also startup h2 and tomcat. So to rebuild, you can use the target test.demo.setup.refresh That target will first shutdown tomcat and h2 and then do a full new demo test setup.
Building the javadocs
Use target build.javadocs in qa/build.xml
Building a distribution
To build a distribution, run target distro of build file distro/build.xml
After an distribution is unzipped (or directly in the distro/target/activiti-version directory), a number of scripts are offered to our users as well. Those scripts can be found in [activiti.home]/setup/build.xml [user.home]/.activiti/build.properties As an example, here's the content of my[user.home]/.activiti/build.properties:activiti.home=/Users/tombaeyens/Documents/workspace/activiti/distro/target/activiti-5.0.alpha1-SNAPSHOT
activiti.home, is used in the setup/build.xml. It will work straight from the sources. So you can add the setup from the sources to your ant view in your IDE.
downloads.dir, is used in the setup/build.xml. It allows you to configure a custom location for your directory to download/find tomcat. If you don't specify this, the default is relative to the setup directory (../downloads). So if you use the setup/build from the sources, you might end up downloading tomcat into your sources. If that still would happen, don't check it in!
tomcat.enable.debug is used in setup/build.xml when tomcat is installed. if the property is specified (whatever value), the following line will be added at the beginning of the catalina.sh:
skip.deploy.activiti.modeler=true set this property if the activiti modeler fetching from net and deployment must be skipped.
Unless before a release or explicitely working on Signavio, it's advised to set this property since sometimes a version matching the current trunk version isn't uploaded yet, causing the demo setup to fail.
mvn.executable=mvn.bat on windows you have to set this property to make the calls from the ant build scripts (distro/build.xml and qa/build.xml) to maven work.
[user.home]/.activiti/tomcat-users.xml To enable the automatic redeployment targets in qa/build.xml, put a tomcat-users.xml in your [user.home]/.activiti directory with the following content:
Build file qa/build.xml contains a number of targets for driving the QA. It also contains convenience targets for developers to do integration testing.
Eclipse IDE Setup
You'll need to install the maven and svn plugins.
In the "Galileo - http://download.eclipse.org/releases/galileo" update site, which should be available automatically, install "Collaboration --> Subversibe SVN Team provider". After rebooting and adding an SVN repository, you'll be asked automatically to install one of the polarion connectors for SVN. Just take the latest version of the polarion connectors. In case that doesn't happen automatically install a polarion connector manually from "Subversive SVN Connectors Site http://community.polarion.com/projects/subversive/download/eclipse/2.0/update-site/"
Install the maven plugins from http://m2eclipse.sonatype.org/sites/m2e
First check out the activiti root from svn as one project. Then import existing projects and navigate to the modules directory. All the module projects should then be found and can be imported in one go.
in the eclipse directory of the root activiti source directory are some files that should be imported as eclipse preferences. The filenames indicate the dialog that can be used to import them.
Debugging ant task
See activiti - signavio rebranding