From 63386027c13331610eb83d08f96a9639586a34be Mon Sep 17 00:00:00 2001 From: Derek DeJonghe Date: Mon, 15 Jun 2020 16:50:41 -0400 Subject: [PATCH] update readme --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 109d78b..ce23a3d 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ Runs with debug logging. ### 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`. \ No newline at end of file +**dockerImage:** The Docker image and tag to run auto-semver with. By default, it pulls `rightbrainnetworks/auto-semver:latest`.