📝 Add description for noTrailingZeroes

orlowdev · Jul 4, 2020 · 9c819b7 · 9c819b7
1 parent 7737dff
commit 9c819b7
Showing 1 changed file with 25 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,7 @@ Check out the [roadmap for the project](https://github.com/priestine/versions/pr
       - [Bump Major](#bump-major)
       - [Public](#public)
       - [Prefix Reset](#prefix-reset)
+      - [No Trailing Zeroes](#no-trailing-zeroes)
       - [Dry Run](#dry-run)
       - [Show Changelog](#show-changelog)
       - [Conventions](#conventions)
@@ -120,24 +121,25 @@ All options that accept `true` or `false` as a value are **false** by default.
 
 ### Overview
 
-| Option                            | CLI Usage Example                            | Environment Usage Example                                    | Default   |
-| --------------------------------- | -------------------------------------------- | ------------------------------------------------------------ | --------- |
-| [Config File](#config-file)       | **--config-file=PATH**                       | **PRIESTINE_VERSIONS_CONFIG_FILE**=PATH                      | `""`      |
-| [Token](#token)                   | **--token=\$SOME_TOKEN**                     | **PRIESTINE_VERSIONS_TOKEN**=\$SOME_TOKEN                    | `""`      |
-| [Repository](#repository)         | **--repository=octocat/github**              | **PRIESTINE_VERSIONS_REPOSITORY**=octocat/github             | `""`      |
-| [Latest Version](#latest-version) | **--latest-version=0.0.0**                   | **PRIESTINE_VERSIONS_LATEST_VERSION**=0.0.0                  | `""`      |
-| [Prefix](#prefix)                 | **--prefix=v**                               | **PRIESTINE_VERSIONS_PREFIX**=v                              | `""`      |
-| [Pre-Release](#pre-release)       | **--pre-release=\$(git rev-parse HEAD)**     | **PRIESTINE_VERSIONS_PRE_RELEAS**=\$(git rev-parse HEAD)     | `""`      |
-| [Build Metadata](#build-metadata) | **--build-metadata=\$(date)**                | **PRIESTINE_VERSIONS_BUILD_METADATA**=\$(date)               | `""`      |
-| [Custom URL](#custom-url)         | **--custom-url=https://api.mygh.com/repos/** | **PRIESTINE_VERSIONS_CUSTOM_URL**=https://api.mygh.com/repos | `""`      |
-| [Merges](#merges)                 | **--merges=\<include \| exclude \| only>**   | **PRIESTINE_VERSIONS_MERGES**=\<include \| exclude \| only>  | `exclude` |
-| [Bump Patch](#bump-patch)         | **--bump-patch**[=\<true \| false>]          | **PRIESTINE_VERSIONS_BUMP_PATCH**=\<true \| false>           | `false`   |
-| [Bump Minor](#bump-minor)         | **--bump-minor**[=\<true \| false>]          | **PRIESTINE_VERSIONS_BUMP_MINOR**=\<true \| false>           | `false`   |
-| [Bump Major](#bump-major)         | **--bump-patch**[=\<true \| false>]          | **PRIESTINE_VERSIONS_BUMP_MAJOR**=\<true \| false>           | `false`   |
-| [Public](#public)                 | **--public**[=\<true \| false>]              | **PRIESTINE_VERSIONS_PUBLIC**=\<true \| false>               | `false`   |
-| [Prefix Reset](#prefix-reset)     | **--prefix-reset**[=\<true \| false>]        | **PRIESTINE_VERSIONS_PREFIX_RESET**=\<true \| false>         | `false`   |
-| [Dry Run](#dry-run)               | **--dry-run**[=\<true \| false>]             | **PRIESTINE_VERSIONS_DRY_RUN**=\<true \| false>              | `false`   |
-| [Show Changelog](#show-changelog) | **--show-changelog**[=\<true \| false>]      | **PRIESTINE_VERSIONS_SHOW_CHANGELOG**=[=\<true \| false>]    | `false`   |
+| Option                                    | CLI Usage Example                            | Environment Usage Example                                    | Default   |
+| ----------------------------------------- | -------------------------------------------- | ------------------------------------------------------------ | --------- |
+| [Config File](#config-file)               | **--config-file=PATH**                       | **PRIESTINE_VERSIONS_CONFIG_FILE**=PATH                      | `""`      |
+| [Token](#token)                           | **--token=\$SOME_TOKEN**                     | **PRIESTINE_VERSIONS_TOKEN**=\$SOME_TOKEN                    | `""`      |
+| [Repository](#repository)                 | **--repository=octocat/github**              | **PRIESTINE_VERSIONS_REPOSITORY**=octocat/github             | `""`      |
+| [Latest Version](#latest-version)         | **--latest-version=0.0.0**                   | **PRIESTINE_VERSIONS_LATEST_VERSION**=0.0.0                  | `""`      |
+| [Prefix](#prefix)                         | **--prefix=v**                               | **PRIESTINE_VERSIONS_PREFIX**=v                              | `""`      |
+| [Pre-Release](#pre-release)               | **--pre-release=\$(git rev-parse HEAD)**     | **PRIESTINE_VERSIONS_PRE_RELEAS**=\$(git rev-parse HEAD)     | `""`      |
+| [Build Metadata](#build-metadata)         | **--build-metadata=\$(date)**                | **PRIESTINE_VERSIONS_BUILD_METADATA**=\$(date)               | `""`      |
+| [Custom URL](#custom-url)                 | **--custom-url=https://api.mygh.com/repos/** | **PRIESTINE_VERSIONS_CUSTOM_URL**=https://api.mygh.com/repos | `""`      |
+| [Merges](#merges)                         | **--merges=\<include \| exclude \| only>**   | **PRIESTINE_VERSIONS_MERGES**=\<include \| exclude \| only>  | `exclude` |
+| [Bump Patch](#bump-patch)                 | **--bump-patch**[=\<true \| false>]          | **PRIESTINE_VERSIONS_BUMP_PATCH**=\<true \| false>           | `false`   |
+| [Bump Minor](#bump-minor)                 | **--bump-minor**[=\<true \| false>]          | **PRIESTINE_VERSIONS_BUMP_MINOR**=\<true \| false>           | `false`   |
+| [Bump Major](#bump-major)                 | **--bump-patch**[=\<true \| false>]          | **PRIESTINE_VERSIONS_BUMP_MAJOR**=\<true \| false>           | `false`   |
+| [Public](#public)                         | **--public**[=\<true \| false>]              | **PRIESTINE_VERSIONS_PUBLIC**=\<true \| false>               | `false`   |
+| [Prefix Reset](#prefix-reset)             | **--prefix-reset**[=\<true \| false>]        | **PRIESTINE_VERSIONS_PREFIX_RESET**=\<true \| false>         | `false`   |
+| [No Trailing Zeroes](#no-trailing-zeroes) | **--no-trailing-zeroes**[=\<true \| false>]  | **PRIESTINE_VERSIONS_NO_TRAILING_ZEROES**=\<true \| false>   | `false`   |
+| [Dry Run](#dry-run)                       | **--dry-run**[=\<true \| false>]             | **PRIESTINE_VERSIONS_DRY_RUN**=\<true \| false>              | `false`   |
+| [Show Changelog](#show-changelog)         | **--show-changelog**[=\<true \| false>]      | **PRIESTINE_VERSIONS_SHOW_CHANGELOG**=[=\<true \| false>]    | `false`   |
 
 > With CLI options that accept **boolean** values, providing those values is **_optional_**. `--bump-patch` and `--bump-patch=true` are completely the same.
 >
@@ -203,6 +205,10 @@ Applying this option is irreversible. This option is only applicable if you don'
 
 Setting this option to true will reset major version to **1** if the prefix changes. This option does not affect the versioning process if prefix is not provided. This option requires declaring public API. If major version was `0`, this option will force it to be set to `1`.
 
+#### No Trailing Zeroes
+
+Remove trailing zeroes in the new version, e.g. `14.0.0` -> `14` or `10.15.0` -> `10.15`. **NOTE**: this is not compliant with Semantic Versioning. This option may be useful for creating new versions under the scheme Apple uses for their software. Alternatively, it can be applied to prettify CalVer-like versions.
+
 #### Dry Run
 
 Execute the command but skip publishing the release. May be useful for debugging or just to check what version your application is going to have next.
@@ -299,6 +305,7 @@ Here is a JSON example with the default settings for @priestine/versions. You ca
   "bumpMajor": false,
   "public": false,
   "prefixReset": false,
+  "noTrailingZeroes": false,
   "dryRun": false,
   "showChangelog": false,
   "conventions": [