diff --git a/README.md b/README.md index cc5417d3056030d2a8851e845f1bbfebce66b1d3..c91a8b7d795b5de064c7028cf04b735994e22309 100644 --- a/README.md +++ b/README.md @@ -137,3 +137,11 @@ You can run the whole suite of tests with the following command: ```sh poetry run pytest ``` + +### Making a release + +Run `poetry version $new_version` to bump the version number in +`pyproject.toml`. Commit the changes. +Now we set a tag using `git tag v$(poetry version -s)` and push everything to +the repository with `git push --tags && git push`. CI will take care for +publishing the new package version to pypi.