Repository files navigation

This creates a set ofJBoss Modules containingApache Luceneand packages the lucene libraries into a WildFlyfeature pack for easy provisioning into your customWildFly server orWildFly Swarm.

Historically the Hibernate Search project has been releasing such modules, for convenience of Apache Luceneusers running applications on WildFly or JBoss EAP.

We now moved these artifacts to a "Lucene only" bundle so that other projects using Lucene don't have todownload the Hibernate Search specific modules, and to attempt to have a single consistent distributionof such modules.

This should also make it easier to release a new bundle of these modules as soon as a new Lucene versionis released, without necessarily waiting for Hibernate Search to have adopted the new Lucene version.

We will use anX.Y.Z.qualifier pattern as recommended byJBoss Project Versioning,wherein theX.Y.Z section will match the version of the Apache Lucene version included in the modules,possibly using a0 for the last figure when this is missing in the Lucene version scheme.

We will add an additional qualifier, lexicographically increasing with further releases, to distinguishdifferent releases of this package when still containing the same version of Apache Lucene library.This might be useful to address problems in the package structure, or any other reason to haveto release a new version of these modules containing the same Lucene version as a previouslyreleased copy of these modules.

An example version could be5.5.0.hibernate02 to contain Apache Lucene version5.5.

Maven users can use thewildfly-server-provisioning-maven-plugin to create a custom WildFly server including these modules:

<plugins><plugin><groupId>org.wildfly.build</groupId><artifactId>wildfly-server-provisioning-maven-plugin</artifactId><version>1.2.0.Final</version><executions><execution><id>server-provisioning</id><goals><goal>build</goal></goals><phase>compile</phase><configuration><config-file>server-provisioning.xml</config-file><server-name>minimal-wildfly-with-lucene</server-name></configuration></execution></executions></plugin>

You will also need aserver-provisioning.xml in the root of your project:

<server-provisioning xmlns="urn:wildfly:server-provisioning:1.1"><feature-packs><feature-packgroupId="org.hibernate.lucene-jbossmodules"artifactId="lucene-jbossmodules"version="${lucene-modules.version}"/><feature-packgroupId="org.wildfly"artifactId="wildfly-servlet-feature-pack"version="${your-preferred-wildfly.version}" /></feature-packs></server-provisioning>

This will make Lucene available as an opt-in dependency to any application deployed on WildFly.To enable the dependency there are various options, documented inClass Loading in WildFly.

N.B.:

• The current version of these modules has been tested withWildFly 11.0.0.Final.
• Depending on the WildFly feature pack you chose, some transitive dependencies may not be available in Maven Central.In that case, you shouldset up the JBoss Nexus repository.

Plugins for other build tools have not been implemented yet, but this should be quite straight forward to do: the above Maven plugin is just a thin wrapper invoking other libraries; these other libraries are build agnostic and are responsible for performing most of the work.

See alsoWildFly provisioning build tools.

The feature packs are also available for downloads as zip files onJBoss Nexus.

Use the provided settings-example.xml file, so that JBoss-specific dependencies can be found:

mvn -s settings-example.xml clean install

mvn -s settings-example.xml release:preparemvn -s settings-example.xml release:perform

This will produce two local commits and a local tag, then upload the artifacts to a staging repository onJBoss Nexus.

If it all works fine, don't forget to:

• release the staging repository on Nexus
• push the commits
• push the tag