Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Prequisites

  • Check out Cargo from SVN into a CARGOHOME directory (wherever you want on your machine).
  • In case your SVN client needs to go through a proxy, have a look at What if I'm behind a proxy?
  • Install Maven 2. Verify your installation works by typing "mvn --version" at a command prompt.
    • CARGO requires Maven 2.0.5 or greater to run
    • CARGO requires Maven 2.1 or greater to compile; in particular the core/samples builds require that version of Maven
Info
titleMaven 3 support

CARGO 1.0.x's Maven 2 plugins do work very well with Maven 3, but CARGO 1.0.x requires Maven 2 for its build process. Starting from CARGO 1.1.x, CARGO also builds on Maven 3, see CARGO-789: Make build work with Maven 3.0.

Building

Info
titleFirst time build

The Cargo build contains functional tests. Those tests are run on different containers. The first time you build Cargo it will download those container distributions which will take some time (the containers are installed into core/samples/java/installs). If you want to tell Cargo to run only on some specific container, see below.

  • Go to CARGOHOME and type "mvn install". This will build the full Cargo project.
  • If you wish to clean all build-generated files, cd to CARGOHOME and type "mvn clean".

Selecting containers

The default list of containers to run on depends a property cargo.containers defined in CARGOHOME/core/samples/pom.xml. It can also be supplied at the commandline by using profiles (-P<containerId>).

For example if you only want to run on Tomcat 5.x you'd write: mvn -Ptomcat5x clean install

There are also some multi-container profiles, for example mvn -Pall-downloadable clean install will build CARGO and test the CARGO samples with all downloadable containers (Jetty's many versions, Tomcat's many versions, etc.)

Tips

  • Type mvn -o to work offline. This improves the build speed as Maven 2 does not check for updates on the remote repository for SNAPSHOTs.

Proxy settings

If you need to build cargo from behind a proxy, proceed as follows:

  • edit the .m2/settings.xml file from your home directory (C:/Documents and Settings/username on Windows),
  • comment out the <proxy> element and fill in the proxy server settings accordingly.