From 4028bb2ec8a8f4d8bd48c423685de1aa2001eb5a Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sat, 3 Nov 2018 11:41:48 -0700 Subject: [PATCH] Version 1.1.0-beta --- README.md | 12 +++---- build.gradle | 2 +- docs/README.html | 89 ++++++++++++++++++++++------------------------ version.properties | 6 ++-- 4 files changed, 52 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 3db1cb5..cefe757 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ version.prerelease=beta Upon running the annotation processor, a source file [`GeneratedVersion.java`](https://github.com/ethauvin/semver/blob/master/examples/java/src/generated/java/net/thauvin/erik/semver/examples/java/GeneratedVersion.java) is automatically generated with static methods to access the semantic version data. The source is based on a fully customizable [Mustache](https://mustache.github.io/) template. -To use your own template, simply create a `version.mustache` file. The processor will automatically look for it. +To use your own template, simply create a `version.mustache` file in the project's root directory. The processor will automatically look for it. To specify your own template name, use: @@ -171,7 +171,7 @@ To install and run from [Maven](http://maven.apache.org/), configure an artifact net.thauvin.erik semver - 1.1.0 + 1.1.0-beta ``` @@ -183,8 +183,8 @@ To install and run from [Gradle](https://gradle.org/), add the following to the ```gradle dependencies { - annotationProcessor 'net.thauvin.erik:semver:1.1.0' - compileOnly 'net.thauvin.erik:semver:1.1.0' + annotationProcessor 'net.thauvin.erik:semver:1.1.0-beta' + compileOnly 'net.thauvin.erik:semver:1.1.0-beta' } ``` @@ -208,8 +208,8 @@ To install and run from [Kobalt](http://beust.com/kobalt/), add the following to ```gradle dependencies { - apt("net.thauvin.erik:semver:1.1.0") - compileOnly("net.thauvin.erik:semver:1.1.0") + apt("net.thauvin.erik:semver:1.1.0-beta") + compileOnly("net.thauvin.erik:semver:1.1.0-beta") } ``` diff --git a/build.gradle b/build.gradle index 459e421..fa6af98 100644 --- a/build.gradle +++ b/build.gradle @@ -131,7 +131,7 @@ javadoc { options.with { tags = ['created'] author = true - addBooleanOption('html4', true) + //addBooleanOption('html4', true) links('https://docs.oracle.com/javase/8/docs/api/') addStringOption('Xdoclint:none', '-quiet') } diff --git a/docs/README.html b/docs/README.html index 7564fa1..a53c851 100644 --- a/docs/README.html +++ b/docs/README.html @@ -50,10 +50,10 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf

Semantic Version Annotation Processor

-

License (3-Clause BSD) release Maven Central Download
-Dependency Status Build Status Build status CircleCI

+

License (3-Clause BSD) release Maven Central Download
+Known Vulnerabilities Build Status Build status CircleCI

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.

+

This processor was inspired by Cédric Beust's version-processor and works well in conjunction with the Semantic Version Plugin for Gradle.

Examples