erik/semver
erik/semver
1
1
Fork 0
Code Issues Pull requests Releases Activity

Changed to relative links.

Browse source
This commit is contained in:
Erik C. Thauvin 2018-07-01 01:18:56 -07:00
parent d2cc1dd590
commit 4da4f15e67
3 changed files with 48 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -37,11 +37,11 @@ version.patch=0
version.prerelease=beta
```
[View Example](https://github.com/ethauvin/semver/tree/master/example)
[View Example](tree/master/examples)
## 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.
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.
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](https://github.com/ethauvin/semver/blob/master/src/main/resources/semver.mustache) implements the following static fields:
The [default template](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.0.0` and may break older versions when using custom property keys.
> :warning: `keysPrefix` is a new element in `1.1.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](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.
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.
### Kobalt
@ -213,7 +213,7 @@ dependencies {
}
```
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.
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.
### Kotlin
@ -228,9 +228,9 @@ import net.thauvin.erik.semver.Version
open class Main {
// ...
```
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).
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).
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)).
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)).
## Auto-Increment