erik/version-processor
erik/version-processor
1
0
Fork 0
mirror of https://github.com/ethauvin/version-processor.git synced 2025-04-24 23:47:11 -07:00
Code Releases Activity

Minor improvements.

Browse source
This commit is contained in:
Cedric Beust 2015-11-14 07:35:29 -08:00
parent ae6392aafd
commit 30f767f45a
7 changed files with 152 additions and 91 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -7,7 +7,27 @@ There are two modules in this project:
- The processor (`processor/`)
- The example using the processor (`example/`)
The `processor` project defines an annotation `@Version` that lets you specify a version number. When the annotation processor is run, it generates a source file `GeneratedVersion.java` with a static field containing that version number.
The `processor` project defines an annotation `@Version` that lets you specify a version number in two ways:
- Either provide a `value` for the version.
- Or you provide a `fileName` pointing to a `Properties` file. This file contains the version number either with the default key `version` or with your own key, which you can specify with the `propertyName` attribute.
For example:
```
@Version(fileName = "example/src/main/properties/version.properties",
propertyName = "example.version")
public class A {
// ...
```
And the content of the `version.properties` file:
```
example.version=1.4
```
When the annotation processor is run, it generates a source file `GeneratedVersion.java` with a static field containing that version number.
The `example` project has a single class `Example` which is annotated with `@Version` and which then displays the value of the version from the `GeneratedVersion` generated class.