docs: extend existing prerelease documentation to include new flag se…

…mantics (#269)

docs/reference/cli/bump.md

@@ -18,11 +18,12 @@ uplift bump [flags]
 ## Global Flags
 
 ```text
---config-dir string   a custom path to a directory containing uplift config (default ".")
---debug               show me everything that happens
---dry-run             run without making any changes
---ignore-detached     ignore reported git detached HEAD error
---ignore-shallow      ignore reported git shallow clone error
---no-push             no changes will be pushed to the git remote
---silent              silence all logging
+--config-dir string            a custom path to a directory containing uplift config (default ".")
+--debug                        show me everything that happens
+--dry-run                      run without making any changes
+--ignore-detached              ignore reported git detached HEAD error
+--ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
+--ignore-shallow               ignore reported git shallow clone error
+--no-push                      no changes will be pushed to the git remote
+--silent                       silence all logging
 ```

docs/reference/cli/changelog.md

@@ -21,11 +21,12 @@ uplift changelog [flags]
 ## Global Flags
 
 ```text
---config-dir string   a custom path to a directory containing uplift config (default ".")
---debug               show me everything that happens
---dry-run             run without making any changes
---ignore-detached     ignore reported git detached HEAD error
---ignore-shallow      ignore reported git shallow clone error
---no-push             no changes will be pushed to the git remote
---silent              silence all logging
+--config-dir string            a custom path to a directory containing uplift config (default ".")
+--debug                        show me everything that happens
+--dry-run                      run without making any changes
+--ignore-detached              ignore reported git detached HEAD error
+--ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
+--ignore-shallow               ignore reported git shallow clone error
+--no-push                      no changes will be pushed to the git remote
+--silent                       silence all logging
 ```

docs/reference/cli/release.md

@@ -25,11 +25,12 @@ uplift release [flags]
 ## Global Flags
 
 ```text
---config-dir string   a custom path to a directory containing uplift config (default ".")
---debug               show me everything that happens
---dry-run             run without making any changes
---ignore-detached     ignore reported git detached HEAD error
---ignore-shallow      ignore reported git shallow clone error
---no-push             no changes will be pushed to the git remote
---silent              silence all logging
+--config-dir string            a custom path to a directory containing uplift config (default ".")
+--debug                        show me everything that happens
+--dry-run                      run without making any changes
+--ignore-detached              ignore reported git detached HEAD error
+--ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
+--ignore-shallow               ignore reported git shallow clone error
+--no-push                      no changes will be pushed to the git remote
+--silent                       silence all logging
 ```

docs/reference/cli/root.md

@@ -11,14 +11,15 @@ uplift [command]
 ## Flags
 
 ```text
-    --config-dir string   a custom path to a directory containing uplift config (default ".")
-    --debug               show me everything that happens
-    --dry-run             run without making any changes
--h, --help                help for uplift
-    --ignore-detached     ignore reported git detached HEAD error
-    --ignore-shallow      ignore reported git shallow clone error
-    --no-push             no changes will be pushed to the git remote
-    --silent              silence all logging
+    --config-dir string            a custom path to a directory containing uplift config (default ".")
+    --debug                        show me everything that happens
+    --dry-run                      run without making any changes
+-h, --help                         help for uplift
+    --ignore-detached              ignore reported git detached HEAD error
+    --ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
+    --ignore-shallow               ignore reported git shallow clone error
+    --no-push                      no changes will be pushed to the git remote
+    --silent                       silence all logging
 ```
 
 ## Commands

docs/reference/cli/tag.md

@@ -21,11 +21,12 @@ uplift tag [flags]
 ## Global Flags
 
 ```text
---config-dir string   a custom path to a directory containing uplift config (default ".")
---debug               show me everything that happens
---dry-run             run without making any changes
---ignore-detached     ignore reported git detached HEAD error
---ignore-shallow      ignore reported git shallow clone error
---no-push             no changes will be pushed to the git remote
---silent              silence all logging
+--config-dir string            a custom path to a directory containing uplift config (default ".")
+--debug                        show me everything that happens
+--dry-run                      run without making any changes
+--ignore-detached              ignore reported git detached HEAD error
+--ignore-existing-prerelease   ignore any existing prerelease when calculating next semantic version
+--ignore-shallow               ignore reported git shallow clone error
+--no-push                      no changes will be pushed to the git remote
+--silent                       silence all logging
 ```

docs/tagging.md

@@ -29,3 +29,9 @@ Uplift has early support for tagging a repository with prerelease metadata. You
 ```sh
 uplift tag --prerelease beta.1+20220930
 ```
+
+If you need Uplift to ignore any existing prerelease metadata when calculating the next semantic version, you must include the `--ignore-existing-prerelease` flag:
+
+```sh
+uplift tag --prerelease beta.1+20221006 --ignore-existing-prerelease
+```