Thanks for checking out Spring Roo from Git.

These instructions are aimed at experienced developers looking to develop Spring Roo itself. If you are new to Spring Roo or would simply like to try a release that has already been built, tested and distributed by the core development team, we recommend that you visit the Spring Roo Home Page and download an official release.

If you are looking for Reference Documentation you can get it here.

These instructions detail how to get started with your freshly checked-out source tree. Follow next steps to develop Spring Roo yourself.

1. One-time setup instructions

2. GPG (PGP) Setup

3. Developing within eclipse

4. Running the command line tool

5. Git Polices

6. Git Tips

7. Releasing

8. Help

We’ll assume you typed the following to checkout Roo (if not, adjust the paths in the following instructions accordingly):

In the instructions below, $ROO_HOME refers to the location where you checked out Roo (in this case it would be ROO_HOME="~/roo"). You do NOT need to add a $ROO_HOME variable. It is simply used in these docs.

Next double-check you meet the installation requirements:

• To get started, make sure your system has as a minimum Java JDK 1.6 or newer installed. Java JDK 1.7 is recommended.

• Maven 3.0.1+ properly installed and working with your Java version

• Internet access so that Maven can download required dependencies

• A Git command line client installed (required by Roo’s Maven build for inserting the current revision number into OSGi bundle manifests)

Next you need to setup an environment variable called MAVEN_OPTS. If you already have a MAVEN_OPTS, just check it has the memory sizes shown below (or greater).

If you’re following our checkout instructions above and are on a *nix machine, you can just type:

Result: MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=512m)

You’re almost finished.

You just need to wrap up with a symbolic link (Windows users instead add $ROO_HOME/bootstrap to your path):

Roo now uses GPG to automatically sign build outputs. If you haven’t installed GPG, download and install it:

• Main site: http://www.gnupg.org/download/

• Apple Mac option: http://macgpg.sourceforge.net/

Ensure you have a valid signature. Use "gpg --list-secret-keys".

You should see some output like this:

If you don’t see the output, it means you first need to create a key.

It’s very easy to do this, just use "gpg --gen-key".

Then verify your newly-created key was indeed created: "gpg --list-secret-keys".

Next you need to publish your key to a public keyserver. Take a note of the "sec" key ID shown from the --list-secret-keys. In my case it’s key ID "00B5050F".

Push your public key to a keyserver via the command "gpg --keyserver hkp://pgp.mit.edu --send-keys 00B5050F" (of course changing the key ID at the end). Most public key servers share keys, so you don’t need to send your public key to multiple key servers.

Finally, every time you build you will be prompted for the password of your key.

You have several options:

• Type the password in every time

• Include a -Dgpg.passphrase=thephrase argument when calling "mvn"

• Edit ~/.bashrc and add -Dgpg.passphrase=thephrase to MAVEN_OPTS

• Edit your active Maven profile to include a "gpg.passphrase" property:

       <profiles>
           <profile>
               <properties>
                   <gpg.passphrase>roorules</gpg.passphrase>

Of course the most secure option is to type the password every time. However, if you’re doing a lot of builds you might prefer automation.

Spring Roo itself does not use AspectJ and therefore any standard IDE can be used for development. No extra plugins are needed and the team use "mvn clean eclipse:clean eclipse:eclipse" to produce Eclipse project files that can be imported via File > Import > Existing Projects into Workspace.

In theory you could use the m2eclipse plugin. The Roo team just tends to use eclipse:clean eclipse:eclipse instead.

Roo uses OSGi and OSGi requires compiled JARs. Therefore as you make changes in Roo, you’d normally need to "mvn package" the relevant project(s), then copy the resulting JAR files to the OSGi container.

To simplify development and OSGi-related procedures, Roo’s Maven POMs have been carefully configured to emit manifests, SCR descriptors and dependencies.

These are mostly emitted when you use "mvn package".

To try Roo out, you should type the following:

It’s important that you run roo-dev from a directory that you’d like to eventually contain a Roo-created project.

If this fails, please review the "OSGi Wrapping JARs" section above.

Notice we used "mvn install" rather than "mvn package". This is simply for convenience, as it will allow you to "cd" into any Roo module subdirectory and "mvn install". This saves considerable build time if changes are only being made in a single module.

Roo ships with a command line tool called "roo-dev". This is also a Windows equivalent. It copies all relevant JARs from the Roo directories into $ROO_HOME/runtime/bootstrap/roo-dev/target/osgi. This directory represents a configured Roo OSGi instance.

"roo-dev" also launches the OSGi container, which is currently Apache Felix. It also activate "development mode", which gives fuller exceptions, more file activity reporting, extra flash messages related to OSGi events etc.

When checking into Git, you must provide a commit message which begins with the relevant Roo Jira issue tracking number. The message should be in the form "ROO-xxx: Title of the Jira Issue". For example:

You are free to place whatever text you like after this prefix. The prefix ensures FishEye is able to correlate the commit with Jira. eg:

You should not commit any IDE or Maven-generated files into Git.

Try to avoid "git pull", as it creates lots of commit messages like "Merge branch 'master' of git.springsource.org:roo/roo". You can avoid this with "git pull --rebase".

See the "Git Tips" below for advice.

Setup Git correctly before you do anything else:

Perform the initial checkout with this:

Let’s take the simple case where you just want to make a minor change against master. You don’t want a new branch etc, and you only want a single commit to eventually show up in "git log". The easiest way is to start your editing session with this:

That will give you the latest code. Go and edit files. Determine the changes with:

You can use "git add -A" if you just want to add everything you see.

Next you need to make a commit. Do this via:

The -e will cause an editor to load, allowing you to edit the message. Every commit message should reflect the "Git Policies" above.

Now if nobody else has made any changes since your original "git pull", you can simply type this:

If the result is '[ok]', you’re done.

If the result is '[rejected]', someone else beat you to it. The simplest way to workaround this is:

The --rebase option will essentially do a 'git pull', but then it will reapply your commits again as if they happened after the 'git pull'. This avoids verbose logs like "Merge branch 'master'".

If you’re doing something non-trivial, it’s best to create a branch. Learn more about this at http://sysmonblog.co.uk/misc/git_by_example/.

Roo is released on a regular basis by the Roo project team. To perform releases and make the associated announcements you require appropriate permissions to many systems (as listed below). As such these notes are intended to assist developers with such permissions complete releases.

Our release procedure may seem long, but that’s because it includes many steps related to final testing and staging releases with other teams.

http://forum.springsource.org is now a read-only archive. All commenting, posting, registration services have been turned off.

If you have any question about Spring-roo project and its functionalities, you can check http://stackoverflow.com/questions/tagged/spring-roo

Thanks for your interest in Spring Roo!