layla/auto-semver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Derek DeJonghe 2020-06-15 16:50:41 -04:00
parent ebe6b60aaf
commit 63386027c1
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -125,7 +125,7 @@ Runs with debug logging.
<a name="semver_get_version"></a>
### semver_get_version
The `semver_get_version` command returns the version number if the `semver` command exited `0`. If `semver` exited anything else, `semver_get_version` will return the branch name.
The `semver_get_version` command returns the version number if the `semver` command exited `0`. If `semver` exited anything else, `semver_get_version` will return the branch name, or a pre-release version if format is specified
#### Flags
@ -137,6 +137,14 @@ Replaces `/` with `.` in branch names. For example, `feature/test` becomes `feat
Runs with debug logging.
`-f`/`--format` `(npm|maven)`
Formats the output for a pre-release version for a specific repository type. For example, `feature/test` becomes `0.1.0-feature-test-SNAPSHOT` for maven with no build number, or `0.1.0-feature-test.0` for maven with no build number.
`-b`/`--build-number` `number`
Provides a build number for pre-release versions.
### Jenkins Shared Library
This repository is also home to a Jenkins shared library to assit in running auto-semver.
@ -168,4 +176,4 @@ pipeline
#### runAutoSemver( String _dockerImage_ )
**dockerImage:** The Docker image and tag to run auto-semver with. By default, it pulls `rightbrainnetworks/auto-semver:latest`.
**dockerImage:** The Docker image and tag to run auto-semver with. By default, it pulls `rightbrainnetworks/auto-semver:latest`.