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

Add support of pre-releases to bump2version #66

Merged
merged 2 commits into from
May 23, 2022
Merged

Add support of pre-releases to bump2version #66

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acaf6f1
add support of pre-releases
t20100 May 23, 2022
b5c34fe
Apply suggestions from code review
t20100 May 23, 2022
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
11 changes: 11 additions & 0 deletions .bumpversion.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ tag = True
commit = True
message = Bump to v{new_version}
tag_message = {now:%Y/%m/%d}
parse = (?P<major>\d+).(?P<minor>\d+).(?P<patch>\d+)((?P<prerelease>.*)(?P<pre>\d+))?
serialize =
{major}.{minor}.{patch}{prerelease}{pre}
{major}.{minor}.{patch}

[bumpversion:part:prerelease]
optional_value = final
first_value = final
values =
b
final

[bumpversion:file:h5grove/__init__.py]

Expand Down
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ The new tag will trigger the CI (`release.yml`) that will build and release the

Release notes can then be written in the [Releases page](https://github.com/silx-kit/h5grove/releases).

t20100 marked this conversation as resolved.
Show resolved Hide resolved
The following commands can be used to handle the pre-release cycle:
- To tag the first pre-release, run `bump2version --new-release <X.Y.Zb0> [patch|minor|major]`
t20100 marked this conversation as resolved.
Show resolved Hide resolved
- To bump the pre-release number, run `bump2version pre`
- To bump to the release, run `bump2version prerelease`

### Documentation

The documentation is generated using [Sphinx](https://www.sphinx-doc.org/en/master/index.html) by parsing Markdown files with [myst-parser](https://myst-parser.readthedocs.io/en/latest/index.html).
Expand Down