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

Added packageName annotation element.

Browse source
This commit is contained in:
Erik C. Thauvin 2017-04-26 11:19:01 -07:00
parent 2810a402b0
commit c65c0033e2
4 changed files with 19 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -112,18 +112,19 @@ Please also look at this [example](https://github.com/ethauvin/mobibot/blob/mast
The following annotation elements and properties are available:
Element | Property | Description | Default
:------------|:---------------------|:----------------------------------|:----------------
`project` | `version.project` | The project name. |
`major` | `version.major` | The major version number. | `1`
`minor` | `version.major` | The minor version number. | `0`
`patch` | `version.patch` | The patch version number. | `0`
`preRelease` | `version.prerelease` | The pre-release version. |
`buildMeta` | `version.buildmeta` | The build metadata version. |
`className` | | The name of the generated class. | `GeneratedVersion`
`properties` | | The properties file. |
`template` | | The template file. | `version.mustache`
`type` | | Either `java` or `kt` for Kotlin. | `java`
Element | Property | Description | Default
:-------------|:---------------------|:----------------------------------|:-------------------------
`project` | `version.project` | The project name. |
`major` | `version.major` | The major version number. | `1`
`minor` | `version.major` | The minor version number. | `0`
`patch` | `version.patch` | The patch version number. | `0`
`preRelease` | `version.prerelease` | The pre-release version. |
`buildMeta` | `version.buildmeta` | The build metadata version. |
`packageName` | | The package name. | _Same as annotated class_
`className` | | The name of the generated class. | `GeneratedVersion`
`properties` | | The properties file. |
`template` | | The template file. | `version.mustache`
`type` | | Either `java` or `kt` for Kotlin. | `java`
In order to easily incorporate with existing projects, the property keys may be assigned custom values: