Project Build Instructions

This page gives instructions for building the Chico JAR files.

Before you do this, you will need to setup the relevant build tools and IDE. Please refer to the tool setup instructions.


Building the JAR files

To perform a clean build of the Chico JAR files, do the following:

  1. Change directory to the "chico" directory in your sandbox.
  2. Run the following command to build the standard JAR files:
        mvn -Dmaven.test.skip=true clean package

The JAR files will be created in the "target" subdirectories of the child modules.

The "-Dmaven.test.skip=true" tells Maven to skip the running of unit and system tests. Some unit tests will inevitably fail unless you have set up your test environment, and this will cause the build to fail.

Building the Maven site documentation tree

To build the Maven site for the project, do the following:

  1. Change directory to the project directory in your sandbox.
  2. Run the following command to build a local copy of the site documentation tree:
        mvn -o site

    This will give you a local copy of the documentation tree in the "target/site" subdirectory.

    The "-o" option causes Maven to not attempt to refresh the bundles for Danno's external dependencies. This speeds up the site build, at the expense of not generating all dependencies.

  3. Provided that you have the correct permissions, you can generate and deploy the site tree to its public location by running:
        mvn site-deploy

    You can browse the "target/site" tree in-place by providing a suitable "file:" URL to your web browser. However the hyperlinks between the parent package and the child packages won't resolve correctly unless the HTML is deployed to its proper place.

    To address this and similar issues, the Maven site plugin also allows you to Stage a site to a staging webserver.