Skip to content

Commit

Permalink
Merge pull request #804 from nsidc/update-bumpversion-docs
Browse files Browse the repository at this point in the history
Update release docs to reflect usage of new version of bumpversion
  • Loading branch information
trey-stafford authored Aug 31, 2023
2 parents 39be7bb + 0ad634f commit 9dc75bc
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions doc/contributor/how-to/release-new-version.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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`.
```

Expand Down

0 comments on commit 9dc75bc

Please sign in to comment.