Add bumpver to help the version bump and push to release branch

- adding maintainers section to README.md

README.md

@@ -125,6 +125,21 @@ To see the full list of configurations you can call `voila` and pass `--help-all
 
 Set the environment variable `ipyoptimade_DEVELOPMENT_MODE` to `1` (the integer version for `True` (`1`) or `False` (`0`)) in order to force the use of development servers for providers (currently only relevant for Materials Cloud).
 
+## For maintainers
+
+To create a new release, clone the repository, install development dependencies with `pip install -e '.[dev]'`, and then execute `bumpver update [--major|--minor|--patch] [--tag-num --tag [alpha|beta|rc]]`.
+This will:
+
+  1. Create a tagged release with bumped version and push it to the repository.
+  2. Trigger a GitHub actions workflow that creates a GitHub release and publishes it on PyPI.
+
+Additional notes:
+
+  - Use the `--dry` option to preview the release change.
+  - The release tag (e.g. a/b/rc) is determined from the last release.
+    Use the `--tag` option to switch the release tag.
+  - This package follows [semantic versioning](https://semver.org/).
+
 ## License
 
 MIT. The terms of the license can be found in the [LICENSE](LICENSE) file.

pyproject.toml

@@ -50,6 +50,7 @@ dev = [
     "pre-commit~=3.6",
     "pytest~=7.4",
     "pytest-cov~=4.1",
+    "bumpver~=2023.1129",
 ]
 
 [project.urls]
@@ -58,4 +59,19 @@ Source = "https://github.com/aiidalab/ipyoptimade"
 Tracker = "https://github.com/aiidalab/ipyoptimade/issues"
 
 [tool.flit.module]
-name = "ipyoptimade"
+name = "ipyoptimade"
+
+[bumpver]
+current_version = "0.1.0"
+version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"
+commit_message = "Bump version: {old_version} -> {new_version}"
+commit = true
+push = true
+
+[bumpver.file_patterns]
+"pyproject.toml" = [
+    'current_version = "{version}"',
+]
+"src/ipyoptimade/version.py" = [
+    '__version__ = "{version}"',
+]