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.

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

Migrate from discontinued bump2version to bump-my-version #1514

Merged
merged 2 commits into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 0 additions & 10 deletions .bumpversion.cfg

This file was deleted.

4 changes: 2 additions & 2 deletions docs/development/tools/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Currently, GT4Py releases are published in PyPI (and TestPyPI) and also as commi

1. Make sure all the expected changes (new features, bug fixes, documentation changes, etc.) are already included in the `main` public branch.

2. Use **bump2version** to update the version number.
2. Use **bump-my-version** to update the version number.

```bash
$ bump2version minor # or patch
$ bump-my-version bump minor # or patch
```

3. Update the [CHANGELOG.md](CHANGELOG.md) file to document the changes included in the new release. Note that this step becomes much simpler when commit messages follow the [Conventional Commits][conventional-commits] convention as encouraged in the [Pull Request and Merge Guidelines](CONTRIBUTING.md#pull-request-and-merge-guidelines) section of the contributing guidelines.
Expand Down
21 changes: 21 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,27 @@ Homepage = 'https://gridtools.github.io/'
Source = 'https://github.com/GridTools/gt4py'

# ---- Other tools ----
# -- bump-my-version --
[tool.bumpversion]
allow_dirty = false
commit = false
commit_args = ''
current_version = '1.0.3'
ignore_missing_version = false
message = 'Bump version: {current_version} → {new_version}'
parse = '(?P<major>\d+)\.(?P<minor>\d+)(\.(?P<patch>\d+))?'
regex = false
replace = '{new_version}'
search = '{current_version}'
serialize = ['{major}.{minor}.{patch}']
sign_tags = false
tag = false
tag_message = 'Bump version: {current_version} → {new_version}'
tag_name = 'v{new_version}'

[[tool.bumpversion.files]]
filename = "src/gt4py/__about__.py"

# -- coverage --
[tool.coverage]

Expand Down
1 change: 1 addition & 0 deletions requirements-dev.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
# should be added here without constraints, so they will use the
# constraints defined in `pyproject.toml`.
#
bump-my-version>=0.19.3
clang-format>=9.0
cogapp>=3.3
coverage[toml]>=5.0
Expand Down
Loading