====================================
Lucene/Solr Maven build instructions
====================================
Contents:
A. How to use nightly Jenkins-built Lucene/Solr Maven artifacts
B. How to generate Maven artifacts
C. How to deploy Maven artifacts to a repository
D. How to use Maven to build Lucene/Solr
-----
A. How to use nightly Jenkins-built Lucene/Solr Maven artifacts
The most recently produced nightly Jenkins-built Lucene and Solr Maven
snapshot artifacts are available in the Apache Snapshot repository here:
An example POM snippet:
<project ...>
...
<repositories>
...
<repository>
<id>apache.snapshots</id>
<name>Apache Snapshot Repository</name>
<url>http://repository.apache.org/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
</repository>
B. How to generate Lucene/Solr Maven artifacts
Prerequisites: JDK 1.5+ and Ant 1.7.X
Run 'ant generate-maven-artifacts' to create an internal Maven
repository, including POMs, binary .jars, source .jars, and javadoc
.jars.
You can run the above command in three possible places: the top-level
directory; under lucene/; or under solr/. From the top-level directory
or from lucene/, the internal repository will be located at dist/maven/.
From solr/, the internal repository will be located at package/maven/.
C. How to deploy Maven artifacts to a repository
Prerequisites: JDK 1.5+ and Ant 1.7.X
You can deploy targets for all of Lucene/Solr, only Lucene, or only
Solr, as in B. above. To deploy to a Maven repository, the command is
the same as in B. above, with the addition of two system properties:
ant -Dm2.repository.id=my-repo-id \
generate-maven-artifacts
The repository ID given in the above command corresponds to a <server>
entry in either your ~/.m2/settings.xml or ~/.ant/settings.xml. See
<http://maven.apache.org/settings.html#Servers> for more information.
(Note that as of version 2.1.3, Maven Ant Tasks cannot handle encrypted
passwords.)
D. How to use Maven to build Lucene/Solr
In summary, to enable Maven builds, perform the following:
svn update
ant get-maven-poms
mvn -N -Pbootstrap install [ -Divy.default.ivy.user.dir=... ]
If your ivy user directory is not in the default location, you can
specify it via -Divy.default.ivy.user.dir=... -- otherwise you don't
need to give this property setting.
The details, followed by some example Maven commands:
1. Prerequisites: JDK 1.5+; Maven 2.2.1 or 3.0.X
2. Make sure your sources are up to date. If you checked your sources out
from the Apache Subversion repository, run "svn update" from the top
level.
3. Copy the Maven POM templates from under dev-tools/maven/ to where they
they need to go in order to drive the Maven build, using the following
command from the top-level directory:
ant get-maven-poms
Note that you will need to do this whenever changes to the POM
templates are committed. It's a good idea to follow every "svn update"
with "ant get-maven-poms" for this reason.
The above command copies all of the POM templates from dev-tools/maven/,
filling in the project version with the default "X.X-SNAPSHOT". If you
want the POMs and the Maven-built artifacts to have a version other than
the default, you can supply an alternate version on the command line
with the above command, e.g.:
ant -Dversion=4.0-my-special-version get-maven-poms
4. Populate your local repository with .jars & POMs for dependencies that
are not available from public Maven repositories (a.k.a. "non-mavenized
dependencies"):
mvn -N -Pbootstrap install [ -Divy.default.ivy.user.dir=... ]
If your ivy user directory is not in the default location, you can
specify it via -Divy.default.ivy.user.dir=... -- otherwise you don't
need to give this property setting.
Note that you will need to do this whenever changes to the non-Mavenized
dependencies are committed. It's a good idea to follow every
"svn update" with "ant get-maven-poms" and "mvn -N -Pbootstrap install"
for this reason.
Some example Maven commands you can use after you perform the above
preparatory steps:
- Compile, package, and install all binary artifacts to your local
repository:
mvn install
After compiling and packaging, but before installing each module's
artifact, the above command will also run all the module's tests.
- Compile, package, and install all binary artifacts to your local
repository, without running any tests:
mvn -DskipTests install
- Compile, package, and install all binary and source artifacts to your
local repository, without running any tests:
mvn -DskipTests source:jar-no-fork install
- Run all tests:
mvn test
- Run all test methods defined in a test class:
mvn -Dtest=TestClassName test