diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 6 |
1 files changed, 5 insertions, 1 deletions
@@ -119,11 +119,15 @@ A none existant pre-release yields #### $KeyArg -`$KeyArg` allows for run time side effects on prerelease versions. This means you can bump ain integer or provide key word argument. Examples: +`$KeyArg` allows for run time side effects on prerelease versions. This means you can bump an integer or provide key word argument. Example use cases: + - add the PR/MR number to the version - add metadata for the version ```bash ❯ bumpver patch --prerelease --prerelease-fmt 'rc.$KeyArg PR_NUM.$BumpInt' --key-args PR_NUM=44 vers.txt 1.2.2-rc.44.0 + +❯ bumpver patch --prerelease --prerelease-fmt 'rc.$KeyArg USER_NAME.$BumpInt' --key-args USER_NAME=grumps vers.txt +1.2.2-rc.grumps.0 ``` |