From 0ad634f40ef310d30dd0fdc9bd22a1cbfa73f2dd Mon Sep 17 00:00:00 2001 From: Trey Stafford Date: Thu, 31 Aug 2023 15:33:46 -0600 Subject: [PATCH] Update release docs to reflect usage of new version of bumpversion --- doc/contributor/how-to/release-new-version.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/contributor/how-to/release-new-version.md b/doc/contributor/how-to/release-new-version.md index 4bade417..e8632da9 100644 --- a/doc/contributor/how-to/release-new-version.md +++ b/doc/contributor/how-to/release-new-version.md @@ -1,9 +1,11 @@ # How to release a new version of QGreenland Core code -Use `bumpversion` to bump the specified part of the version: +Use `bumpversion` (see +[bump-my-version](https://github.com/callowayproject/bump-my-version)) to bump +the specified part of the version: ``` -$ bumpversion --part={major|minor|patch} +$ bumpversion bump {major|minor|patch|prerelease|build|} ``` Versions should be in one of the following forms: @@ -14,8 +16,8 @@ Versions should be in one of the following forms: * `vX.Y.Z`: A final release, e.g. `v1.2.3`. ```{caution} -When using `bumpversion build`, ensure you have already used `bumpversion -prerelease`. Running `bumpversion build` from a final release version number +When using `bumpversion bump build`, ensure you have already used `bumpversion +bump prerelease`. Running `bumpversion bump build` from a final release version number can result in an incorrect patch number, e.g. `v1.2.304`. ```