Building & Installing jspwiki-tools

jspwiki-tools uses the Craftsman Build System. Craftsman makes use of ant, so this project is built using the supplied ant script. The build is configured to automatically download any required libraries from on-line sources. If the build requires a local library or toolkit to be in place in order to build, it will be documented in the BUILDING.txt file found in the root of the source tree.

If you do not have Craftsman installed, the Craftsman bootstrap process will walk you through the steps of downloading and installing the Craftsman libraries into the local directory.

Please see the guide for using Craftsman if you have any questions about using the ant build script.

Building the project

To build the project, issue the following command:

ant clean build

This will compile, test, and build the project. The resulting jars will be in the individual modules' build/jar directories.

Skipping Unit Tests

While it is not recommended to skip unit tests (as test failure usually indicates a problem), some unit tests cannot function without special setup (such as a test database or a test application server). The project will not build unless the unit tests pass, so this can sometimes be an issue.

To skip unit testing, use the "skip.tests=1" option with your build:

ant -Dskip.tests=1 clean build

You can also make this setting permanent for your local build by adding the following to your build.properties file (if you do not have one, just create it in the top directory where the build.xml and craftsman.xml files live):

skip.tests=1

This setting will skip executing the unit tests (but the build will still compile them).

Generating documentation

Issue the following command to generate documentation for the project:

ant doc

Creating bundles for distribution or use

Craftsman allows project modules to be distributed in bundles. These bundles could contain the jars, wars, or ears from the project modules. These bundles are configured in the build.xml by the project maintainer.

To create this bundles, issue the following command:

ant clean build bundle

This will create any configured bundles and place them in the current directory.

When in doubt ...

If you still aren't sure what you should do or what you should call, either go see the guide or issue the following command:

ant -projecthelp

Installation

Any final products of the jspwiki-tools build will be contained within the build/jar directories of the individual modules or in the final bundles created by the "ant bundle" command. Install these libraries and applications per your environment or IDE requirements.

Please see the INSTALLING.txt for more information on installing the final product of the jspwiki-tools build.