An annotation processor that automatically generates a GeneratedVersion class based on a Mustache template and containing the semantic version (major, minor, patch, etc.) that is read from a Properties file or defined in the annotation.
This processor was inspired by Cédric Beust's version-processor and works well in conjunction with the Semantic Version Plugin for Gradle.
+The default template implements the following static fields:
+The default template implements the following static variables:
And the following methods/functions:
-| Method | -Description | -Example | -
|---|---|---|
preReleaseWithPrefix() |
-Returns the pre-release with a prefix, - by default. |
--alpha |
-
buildMetaWithPrefix() |
-Returns the build metadata with a prefix, + by default. |
-+001 |
-
A very simple custom template might look something like:
/* version.mustache */
@@ -215,12 +218,8 @@ code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warni
public final class {{className}} {
public final static String PROJECT = "{{project}}";
public final static Date DATE = new Date({{epoch}}L);
- public final static int MAJOR = {{major}};
- public final static int MINOR = {{minor}};
- public final static int PATCH = {{patch}};
- public final static String PRERELEASE = "{{preRelease}}";
- public final static String BUILDMETA = "{{buildMeta}}";
-}The mustache variables automatically filled in by the processor are:
| The version separator. | String |
+|
{{semver}} or {{version}} |
+The full semantic version. | +String |
+
Please also look at this example using java.time
⚠️ keysPrefix is a new element staring in 1.1.0 and may break older versions when using custom property keys.
⚡ A quick fix is to include keysPrefix="" in the annotation to remove the default version. prefix.
To install and run from Maven, configure an artifact as follows:
<dependency>
@@ -431,9 +435,11 @@ code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warni
<artifactId>semver</artifactId>
<version>1.2.0</version>
</dependency>Please look at pom.xml in the Java example directory for a sample:
+To install and run from Gradle, add the following to the build.gradle file:
To install and run from Gradle, add the following to build.gradle:
dependencies {
annotationProcessor 'net.thauvin.erik:semver:1.2.0'
compileOnly 'net.thauvin.erik:semver:1.2.0'
@@ -441,19 +447,11 @@ code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warni
The GeneratedVersion class will be automatically created in the build/generated directory upon compiling.
In order to also incorporate the generated source code into the source tree, add the following to the very top of the build.gradle file:
In order to also incorporate the generated source code into the source tree, add the following to the very top of build.gradle:
compileJava.options.annotationProcessorGeneratedSourcesDirectory = file("${projectDir}/src/generated/java")
The GeneratedVersion.java file will now be located in src/generated.
Please look at the build.gradle file in the Java example module directory for a sample.
-To install and run from Kobalt, add the following to the Build.kt file:
dependencies {
- apt("net.thauvin.erik:semver:1.2.0")
- compileOnly("net.thauvin.erik:semver:1.2.0")
-}
-Please look at the Build.kt file in the Java example module directory for a sample.
+Please look at build.gradle in the Java example directory for a sample.
The annotation processor also supports Kotlin.
To generate a Kotlin version file, simply specify the type as follows:
The Kotlin default template implements the same static fields and functions as the Java template.
-Please look at the Kotlin example project for samples on using Gradle (build.gradle.kts) and Kobalt (Build.kt).
+To install and run from Gradle, add the following to build.gradle.kts:
var semverProcessor = "net.thauvin.erik:semver:1.2.0"
+
+dependencies {
+ kapt(semverProcessor)
+ compileOnly(semverProcessor)
+}As of Kotlin 1.2.30, when using kapt you must include the following in gradle.properties:
This option will likely be enabled by default in the future, but is currently not working under Java 10/11 see KT-26203.
+Please look at the Kotlin example project for a build.gradle.kts sample.
+To install and run from Kobalt, add the following to Build.kt:
dependencies {
+ apt("net.thauvin.erik:semver:1.2.0")
+ compileOnly("net.thauvin.erik:semver:1.2.0")
+}
+Please look at Build.kt in the Java example directory for a sample.
Incrementing the version is best left to your favorite build system. For a solution using Gradle, please have a look at the Semver Version Plugin for Gradle.
There are also full examples in both Java and Kotlin showing how to use both the plugin and annotation processor concurrently.