...
The Wicket projects are built using a multi-module build as proposed by the Maven project.
We use Maven to build our projects and distributions. To be able to build Wicket directly
from subversion, you will need an understanding of Maven.
This document contains the following sections.
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
For more information on the project structure, please read the 'Better Builds With Maven'
book which has a detailed description on how to structure a maintainable, enterprise ready
build. The book is available for free from the Mergere website.
Getting your Wicket version
When you build from SVN you will need to should check out a the whole branch, because our project depend
of trunk or the selected branch as the project consists of various modules that may depend on one another. For Wicket the current (1.x 4) development branch, you will need to check out:
svn co httpshttp://svn.apache.org/repos/asf/incubator/wicket/branches/wicket-1.x
trunk
This will give you a directory structure like the following directory tree:
- wicket-
...
- 1.x
- wicket-1.x/wicket
- wicket-1.x/
...
- wicket-extensions
...
- wicket-
...
- 1.x/
...
- wicket-spring
...
- wicket-
...
- 1.x/wicket-auth-roles
- wicket-1.x/wicket-examples
- wicket-1.x/wicket-spring-annot
- ...
In this document we focus at the Wicket parent projectmaven project descriptor located in the top level directory, which enforces default settings for
all Wicket projects such as plug-in settings, versioning of the Wicket projects, managing the
various dependencies and more.
The artifacts in this project are there only for having a consistent build. This top-level project
doesn't have sources for itself.
Building Wicket 1.x
The build has two parts: a Java 1.4 part for the projects that are Java 1.4 based and
a Java 5 part, specific for the projects that are Java 5 based.
Here's a list of the Java 1.4 based projects:
- wicket
- wicket-extensions
- wicket-examples
- wicket-quickstart
- wicket-spring
- wicket-spring-examples
- wicket-portlet-examples
Here's a list of the Java 5 based projects:
- wicket-jmx
- wicket-auth-roles
- wicket-auth-roles-examples
- wicket-spring-annot
- wicket-spring-annot-examples
To build the projects, make sure you have downloaded and installed all projects in one
directory structure, each project a subdirectory next to one another. If you want to get it
all in one sweep, then use subversion to checkout the whole project structure in one go.
current development version of Wicket requires at least jdk 1.5.
svn co httpsvn co https://svn.apache.org/repos/asf/incubator/wicket/releases/<VERSION>
substituting the <VERSION> part with "wicket-X.Y.Z", where X, Y and Z are the major, minor and
bugfix version. So for Wicket-1.2.4 you would check out:
svn co https://svn.apache.org/repos/asf/incubator/wicket/releases/wicket-1.2.4
The development version of wicket 1.x can be found in branch wicket-1.x, and
the latest and greatest development version (currently Wicket 2.x) can be found in trunk.
The branches 1.0.x, 1.1.x and 1.2.x are for versions that are no longer actively
developed, but which may in exception cases receive bug fixes.
Stage one:
mvn -Pjdk1.4 install
Stage two (if you're running JDK 5):
{{mvn -Pjdk1.5 install }}
If you want to ensure that your Wicket version is built using JDK-1.5 and fully compatible with that Java version, you will need to build it with a Java 1.5 compiler and runtime library.
Building all of Wicket is as simple as issuing the following command in the root directory:
Code Block |
---|
mvn install
|
This will compile, test, package and install all Wicket projects. Installation means putting the jar files into your local Maven repository, including the source, but without the javadoc jars (this is a Wicket specific configuration, because build javadoc takes a long timeYou may need to run with -Dmaven.test.skip=true
if you have failing unit tests (this obviously
shouldn't be the case for a release build).
The following commands are useful:
Commandline | Description |
---|---|
mvn clean | cleans up build artifacts |
mvn compile | compiles the projects |
mvn package | creates the jar files in the target/ subdirectories |
mvn install | installs the jar files in your local repository |
mvn -Prelease package | generates the javadoc/source jars as well |
You can just run the install target, as Maven will build the previous stages automatically.
Coping with test failures
As this is our main development you might/will encounter failing unit tests. These can be skipped using:
Code Block |
---|
mvn -Dmaven.test.skip=true install |
Of course, all bets are off then and your mileage may vary if you use such a built jar.
Using your own built artifacts
Now you have built your own fresh Wicket jar you must be anxious to use it. This is now as simple as adding a snapshot dependency on the specific Wicket version. So in your pom.xml you can use:
Code Block | ||||
---|---|---|---|---|
| ||||
<dependency> <groupId>org.apache.wicket</groupId> <artifactId>wicket</artifactId> <version>1.4-SNAPSHOT</version> <scope>compile</scope> </dependency> |
And adding this to your Eclipse, NetBeans or IntelliJ IDEA project classpath is then as simple as:
mvn eclipse:eclipse
mvn netbeans:netbeans
ormvn idea:idea
Maven will then add all the necessary JAR files to the project's classpath.
One thing you need to make sure is that you have set the M2_REPO
classpath variable in Eclipse (or a similar construct in Netbeans), and point it to your local repository, typically found in C:\Documents and Settings\username\.m2\repo
or (for unix buffs) ~/.m2/repo
You can add this setting using maven:
Code Block |
---|
mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add- |
...
maven-repo
|