JBoss Community

This article is a replacement for its precursor, How to Build JBoss Tools 3.3 with Maven 3.

Note that this article only discusses building from trunk. To work with another branch, see Learn.GitHub - Branching and Merging.

Looking for how to build our documentation? See Building JBoss Tools Documentation.

Environment Setup

Prerequisistes

1. Java 1.6 SDK
2. Maven 3.0.3
3. About 6 GB of free disk space if you want to run all integration tests for (JBoss AS, Seam and Web Services Tools) - requires VPN access
4. subversion client 1.6.X  (should work with lower version as well, but newer versions may not work as expected)

Maven and Java

Make sure your maven 3 is available by default and Java 1.6 is used.

 mvn -version

should  print out something like

Apache Maven 3.0.3 (r1075438; 2011-02-28 12:31:09-0500)
Java version: 1.6.0_25, vendor: Sun Microsystems Inc.
Java home: /usr/java/jdk1.6.0_25/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "linux", version: "2.6.42.3-2.fc15.x86_64", arch: "amd64", family: "unix"

Maven settings

Follow these instructions to add reference to JBoss Repositories into your settings.xml. You'll also probably need access to the SNAPSHOT repository. So here is what you should see in your ~/.m2/settings.xml

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
   ....
    <profiles>
        ....
        <profile>
            <id>jboss-default</id>
            <repositories>
                <!-- To resolve parent artifact -->
                <repository>
                    <id>jboss-public-repository-group</id>
                    <name>JBoss Public Repository Group</name>
                    <url>http://repository.jboss.org/nexus/content/groups/public/</url>
                </repository>
                <repository>
                    <id>jboss-snapshots-repository</id>
                    <name>JBoss Snapshots Repository</name>
                    <url>https://repository.jboss.org/nexus/content/repositories/snapshots/</url>
                </repository>
            </repositories>

            <pluginRepositories>
                        <!-- To resolve parent artifact -->
                        <pluginRepository>
                                <id>jboss-public-repository-group</id>
                                <name>JBoss Public Repository Group</name>
                                <url>http://repository.jboss.org/nexus/content/groups/public/</url>
                        </pluginRepository>
                        <pluginRepository>
                                <id>jboss-snapshots-repository</id>
                                <name>JBoss Snapshots Repository</name>
                                <url>https://repository.jboss.org/nexus/content/repositories/snapshots/</url>
                        </pluginRepository>
                </pluginRepositories>
        </profile>
    </profiles>

    <activeProfiles>
        <activeProfile>jboss-default</activeProfile>
        ...
    </activeProfiles>
</settings>

#

What if Maven can't find the upstream artifacts in Nexus? / Building Parent Pom & Target Platforms Locally

Sometimes, Maven can't find the upstream artifacts - parent pom, tycho plugins, minimum (Juno SR0) or maximum (Juno SR1 or later) target platforms. Or maybe you want to build them locally in order to see how Tycho builds them, or contribute a fix. To work around resolution problems, just build locally:

cd /tmp; 
     git clone git clone git://github.com/jbosstools/jbosstools-maven-plugins.git
cd /tmp; 
     git clone git clone git://github.com/jbosstools/jbosstools-build.git
cd jbosstools-maven-plugins/tycho-plugins; mvn install; cd -
cd jbosstools-build/parent;  mvn install; cd -
cd jbosstools-build/target-platforms; mvn install -Pjbosstools-minimum,jbosstools-maximum

Maven & Java Memory Configuration

To configure the amount of memory used by Maven, you can define MVN_OPTS as follows, either in the mvn / mvn.bat script you use to run Maven, or set as global environment variables. Here's how to do so for Fedora, Ubuntu, Windows, OSX.

{code}
set MAVEN_OPTS=-Xms512m -Xmx1024m -XX:PermSize=128m -XX:MaxPermSize=256m
{code}

Verify or Install?

mvn verify will perform all build and test steps, but it won't install the bundles in your local repository. mvn install does install in you local repository. When an eclipse-plugin is installed in your repo, it is always used as default when resolving dependency. It is not possible to roll-back a local installation of a bundle, so in most cases, mvn verify is to be prefered to mvn install. However, if you want to build stuff sequentially through several maven invocations, and you want to resolve against just-built stuff, you'll need to use mvn install.

In this page, we'll encourage people to use mvn verify as much as possible to ensure isolation; but you can mvn install the same way if your use-case requires it.

About Target Platform and related profiles

The target platform (TP) lists all dependencies (coming from Eclipse.or and other 3rd-party update sites) that are used by JBoss Tools. This target platform is materialized as an Eclipse p2 repository (formerly update-site) that is used during build to resolve dependencies. Target Platform is managed by JBoss Tools people, and only dependencies from this TP are allowed to be used in code.

If you need a new dependency in the TP, feel free to open a ticket to request it.

Here are several ways to build locally using this target platform. It's up to you to choose the one that match your needs:

Using published Target Platform definition (Recommended)

unified.target refers to the dependency as published in the Target Platform repository.

• Pros:
  • No additional thing to do than invoking Maven
  • Always up-to-date
• Cons: Speed - (to evaluate)

Consume it by adding -Punified.target to you Maven invocation command-line

Or, getting a local copy of the Target Platform

• Pros: Speed +++
• Cons: Step to be repeated whenever target platforms change

Get it

Download TP as a zip and install it by yourself

You can either download the TP as a zip and unpack it into some folder on your disk. Just remember to update your settings.xml file to point at the location where you unpacked it.

You can get it with a browser or a command line tool such as wget or curl at the following url:

    http://download.jboss.org/jbosstools/updates/juno/SR0c/e420-wtp340.target.zip (current minimum TP)

    http://download.jboss.org/jbosstools/updates/juno/SR1a/e421-wtp341.target.zip (current maximum TP)

and then unzip it :

unzip *.target.zip -d /path/to/jbosstools-build/target-platforms/jbosstools-JunoSR0c/multiple/target/multiple.target.repo/
  or
unzip *.target.zip -d /path/to/jbosstools-build/target-platforms/jbosstools-JunoSR1a/multiple/target/multiple.target.repo/

OR, use Maven to build it

See Building Parent Pom & Target Platforms Locally

#

Use it as a Maven mirror

Once you get the target platform available locally, you can use it instead of the remote sites to save time. For this, we can simply use Tycho target-platform mirroring: http://wiki.eclipse.org/Tycho/Target_Platform/Authentication_and_Mirrors#Mirrors

As example, you can simply edit to your ~/.m2/settings.xml the definition of the repositories to mirror: (replace /home/hudson/static_build_env/jbds/.... by a path where your local repository actuaaly stands)

<settings>
     <mirrors>
<!-- IMPORTANT: Sites in target platforms: must not have trailing slash! -->
        <mirror>
            <id>jenkins.jbosstools-JunoSR0c</id>
            <mirrorOf>http://download.jboss.org/jbosstools/updates/juno/SR0c/REPO</mirrorOf>
            <url>file:///home/hudson/static_build_env/jbds/target-platform_4.0.juno.SR0c/e420-wtp340.target/</url>
            <layout>p2</layout>
            <mirrorOfLayouts>p2</mirrorOfLayouts>
        </mirror>
        <mirror>
            <id>jenkins.jbosstools-JunoSR1a</id>
            <mirrorOf>http://download.jboss.org/jbosstools/updates/juno/SR1a/REPO</mirrorOf>
            <url>file:///home/hudson/static_build_env/jbds/target-platform_4.0.juno.SR1a/e421-wtp341.target/</url>
            <layout>p2</layout>
            <mirrorOfLayouts>p2</mirrorOfLayouts>
        </mirror>
        <mirror>
            <id>jenkins.jbdevstudio-JunoSR0c</id>
            <mirrorOf>http://www.qa.jboss.com/binaries/RHDS/updates/jbds-target-platform_4.0.juno.SR0c/REPO</mirrorOf>
            <url>file:///home/hudson/static_build_env/jbds/jbds-target-platform_4.0.juno.SR0c/jbds600-e420-wtp340.target/</url>
            <layout>p2</layout>
            <mirrorOfLayouts>p2</mirrorOfLayouts>
        </mirror>
        <mirror>
            <id>jenkins.jbdevstudio-JunoSR1a</id>
            <mirrorOf>http://www.qa.jboss.com/binaries/RHDS/updates/jbds-target-platform_4.0.juno.SR1a/REPO</mirrorOf>
            <url>file:///home/hudson/static_build_env/jbds/jbds-target-platform_4.0.juno.SR1a/jbds600-e421-wtp341.target/</url>
            <layout>p2</layout>
            <mirrorOfLayouts>p2</mirrorOfLayouts>
        </mirror>
    </mirrors>
</settings>

(Optional) Build parent and target platform

This step is only useful if you are actually working on the parent or the target platforms and want to test local changes. Otherwise, Maven will simply retrieve parent and TP definitions from JBoss Nexus to perform your build.

source.. = src/ 
output.. = bin/ 
src.includes = *
src.excludes = src
bin.includes = <your own,\
    list of,\
    files for inclusion,\
    in the jar>