From 65ee5339528f75caf5dc9a63e9c1055dd65c2438 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sun, 1 Jul 2018 01:29:51 -0700 Subject: [PATCH] Revert "Changed to relative links." This reverts commit 4da4f15e6773d453a76dda50243143e8ee0e6eca. --- README.md | 16 +++++----- build.gradle | 1 - docs/README.html | 83 +++++++++++++++++++++++++----------------------- 3 files changed, 52 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 6f2f00a..e514584 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,11 @@ version.patch=0 version.prerelease=beta ``` -[View Example](tree/master/examples) +[View Example](https://github.com/ethauvin/semver/tree/master/example) ## Template -Upon running the annotation processor, a source file [`GeneratedVersion.java`](blob/master/example/src/generated/java/net/thauvin/erik/semver/example/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. +Upon running the annotation processor, a source file [`GeneratedVersion.java`](https://github.com/ethauvin/semver/blob/master/example/src/generated/java/net/thauvin/erik/semver/example/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. @@ -55,7 +55,7 @@ public class A { ### Default Template -The [default template](blob/master/src/main/resources/semver.mustache) implements the following static fields: +The [default template](https://github.com/ethauvin/semver/blob/master/src/main/resources/semver.mustache) implements the following static fields: Field | Description | Example :--------------|:---------------------------------|:----------------- @@ -158,7 +158,7 @@ example.meta= # ... ``` -> :warning: `keysPrefix` is a new element in `1.1.0` and may break older versions when using custom property keys. +> :warning: `keysPrefix` is a new element in `1.0.0` and may break older versions when using custom property keys. > :zap: A quick fix is to include `keysPrefix=""` in the annotation to remove the default `version.` prefix. ## Usage with Maven, Grail, Kobalt and Kotlin @@ -200,7 +200,7 @@ compileJava.options.annotationProcessorGeneratedSourcesDirectory = file("${proje The `GeneratedVersion.java` file will now be located in `src/generated`. -Please look at the [build.gradle](blob/master/examples/java/build.gradle) file in the [Java example](tree/master/example/java) module directory for a sample. +Please look at the [build.gradle](https://github.com/ethauvin/semver/blob/master/example/build.gradle) file in the [example](https://github.com/ethauvin/semver/tree/master/example) module directory for a sample. ### Kobalt @@ -213,7 +213,7 @@ dependencies { } ``` -Please look at the [Build.kt](blob/master/examples/kotlin/kobalt/src/Build.kt) file in the [Kotlin example](tree/master/example/kotlin) module directory for a sample. +Please look at the [Build.kt](https://github.com/ethauvin/semver/blob/master/example/kobalt/src/Build.kt) file in the [example](https://github.com/ethauvin/semver/tree/master/example) module directory for a sample. ### Kotlin @@ -228,9 +228,9 @@ import net.thauvin.erik.semver.Version open class Main { // ... ``` -The [Kotlin default template](blob/master/src/main/resources/semver-kt.mustache) implements the same static fields and functions as the [Java template](#default-template). +The [Kotlin default template](https://github.com/ethauvin/semver/blob/master/src/main/resources/semver-kt.mustache) implements the same static fields and functions as the [Java template](#default-template). -Please look at the [Kotlin example](tree/master/examples/Kotlin) project for samples on using Gradle ([build.gradle.kts](blob/master/examples/kotlin/build.gradle.kts)) and Kobalt ([Build.kt](blob/master/examples/kotlin/kobalt/src/Build.kt)). +Please look at the [Example for Kotlin](https://github.com/ethauvin/semver-example-kotlin) project for samples on using Gradle ([build.gradle](https://github.com/ethauvin/semver-example-kotlin/blob/master/build.gradle)) and Kobalt ([Build.kt](https://github.com/ethauvin/semver-example-kotlin/blob/master/kobalt/src/Build.kt)). ## Auto-Increment diff --git a/build.gradle b/build.gradle index 2197cb5..027e847 100644 --- a/build.gradle +++ b/build.gradle @@ -212,7 +212,6 @@ task pandoc(type: Exec) { '-s', '-c', 'github-pandoc.css', '-o', 'docs/README.html', - '-H', 'docs/header.inc', 'README.md'] if (Os.isFamily(Os.FAMILY_WINDOWS)) { commandLine(['cmd', '/c', 'pandoc'] + pandoc_args) diff --git a/docs/README.html b/docs/README.html index 3808cb0..7564fa1 100644 --- a/docs/README.html +++ b/docs/README.html @@ -47,14 +47,13 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf -

Semantic Version Annotation Processor

-

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

+

License (3-Clause BSD) release Maven Central Download
+Dependency Status 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 and works well in conjunction with the Semantic Version Plugin for Gralde.

+

This processor was inspired by Cédric Beust's version-processor.

Examples