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

More cleanup.

Browse source
This commit is contained in:
Erik C. Thauvin 2018-06-30 23:28:47 -07:00
parent 089ede6006
commit 1e4e6a9608
1 changed files with 27 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -19,8 +19,8 @@ By default, a `version.properties` file will be created when Gradle is run:
version.major=1 version.major=1
version.minor=0 version.minor=0
version.patch=0 version.patch=0
version.preRelease= version.prerelease=
version.buildMeta= version.buildmeta=
``` ```
To change the version of your project, remove the version from your `build.gradle` and simply edit your the version properties file to match your version number. To change the version of your project, remove the version from your `build.gradle` and simply edit your the version properties file to match your version number.
@ -60,16 +60,16 @@ Property | Description | Default
`version.major` | The major version. | `1` `version.major` | The major version. | `1`
`version.minor` | The minor version. | `0` `version.minor` | The minor version. | `0`
`version.patch` | The patch version. | `0` `version.patch` | The patch version. | `0`
`version.preRelease` | The pre-release version | `version.prerelease` | The pre-release version |
`version.buildMeta ` | The build metatdata version | `version.buildmeta` | The build metatdata version |
`version.preReleasePrefix` | The pre-release prefix | `-` `version.prerelease.prefix` | The pre-release prefix | `-`
`version.buildMetaPrefix ` | The build metadata prefix | `+` `version.buildmeta.prefix` | The build metadata prefix | `+`
`version.separator` | The version separator. | `.` `version.separator` | The version separator. | `.`
The version number is built as follows: The version number is built as follows:
`version.major` `version.separtor` `version.minor` `version.separator` `version.preReleasePrefix` `version.preRelease` `version.buildMetaPrefix` `version.buildMeta` `version.major` `version.separtor` `version.minor` `version.separator` [`version.prerelease.prefix` `version.prerelease`] [`version.prerelease.prefix` `version.buildmeta`]
for example: for example:
@ -78,8 +78,8 @@ for example:
version.major=1 version.major=1
version.minor=0 version.minor=0
version.patch=0 version.patch=0
version.preRelease=beta version.prerelease=beta
version.buildMeta=exp.sha.5114f85 version.buildmeta=exp.sha.5114f85
``` ```
`projet.version` will be `1.0.0-beta+exp.sha.5114f85` in Gradle. `projet.version` will be `1.0.0-beta+exp.sha.5114f85` in Gradle.
@ -102,22 +102,22 @@ or using different property keys for the version data:
```gradle ```gradle
semver { semver {
keysPrefix = "" // no prefix keysPrefix = "" // no prefix
majorKey = "major" majorKey = "maj"
minorKey = "minor" minorKey = "min"
patchKey = "patch" patchKey = "build"
preReleaseKey = "prerelease" preReleaseKey = "rel"
buildMetaKey = "metadata" buildMetaKey = "meta"
} }
``` ```
which would match the data in `my.version`: which would match the data in `my.version`:
```ini ```ini
#my.version #my.version
major=1 maj=1
minor=0 min=0
patch=0 build=0
prerelease=beta rel=beta
metadata= meta=
``` ```
The following `semver` properties are available: The following `semver` properties are available:
@ -149,8 +149,8 @@ semver {
test.major=1 test.major=1
test.minor=0 test.minor=0
test.patch=0 test.patch=0
test.preRelease= test.prerelease=
test.buildMeta= test.buildmeta=
``` ```
## Source Code Generation ## Source Code Generation