Commit db179b23 authored by Guus der Kinderen's avatar Guus der Kinderen Committed by GitHub

OF-546: Allow plugin name override. (#781)

By default, the Maven structure uses the Maven artifactId value as the name for a plugin.
Maven artifactIds typically include tokens that will cause problems, such as dashes and dots.
The plugin name is used in various places, that all have limitations: filenames (the jar file
itself, the i18n files), package names (for the java files generated from JSPs), etc.

This commit allows the name of the plugin to be overridden using a maven property 'plugin.name'
and includes instructions on what the best format is.
parent 54687deb
...@@ -51,6 +51,15 @@ ...@@ -51,6 +51,15 @@
<properties> <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- The name of the Openfire plugin (defaults to ${project.artifactId}. This value is somewhat particular:
- * It is used as a Java package name (and thus, cannot contain characters like dashes and dots.
- * It is also used as a file name for the resulting Openfire plugin.
- * Finally, it is used to identify resources, such as i18n files.
- Least issues will occur when this value is all lowercase, simple ASCII text.
-->
<plugin.name>${project.artifactId}</plugin.name>
<!-- Versions --> <!-- Versions -->
<openfire.version>4.2.0-SNAPSHOT</openfire.version> <openfire.version>4.2.0-SNAPSHOT</openfire.version>
</properties> </properties>
...@@ -89,7 +98,7 @@ ...@@ -89,7 +98,7 @@
</goals> </goals>
<configuration> <configuration>
<appendAssemblyId>false</appendAssemblyId> <appendAssemblyId>false</appendAssemblyId>
<finalName>${project.artifactId}</finalName> <finalName>${plugin.name}</finalName>
<attach>false</attach> <attach>false</attach>
<!-- This is where we use our shared assembly descriptor --> <!-- This is where we use our shared assembly descriptor -->
<descriptorRefs> <descriptorRefs>
...@@ -116,7 +125,7 @@ ...@@ -116,7 +125,7 @@
</goals> </goals>
<configuration> <configuration>
<jspc> <jspc>
<package>org.jivesoftware.openfire.plugin.${project.artifactId}</package> <package>org.jivesoftware.openfire.plugin.${plugin.name}</package>
</jspc> </jspc>
</configuration> </configuration>
</execution> </execution>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment