Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update release docs to reflect usage of new version of bumpversion #804

Merged
merged 1 commit into from
Aug 31, 2023
Merged

Update release docs to reflect usage of new version of bumpversion #804

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions doc/contributor/how-to/release-new-version.md
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call! I completely ignored the deprecation warnings. Smart to update our docs to respect them now, because who knows when they will become errors!

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