From 79a6c16e8f3cee5ee8ff8d7f7dddc8ada067b56b Mon Sep 17 00:00:00 2001 From: Georg Krause <mail@georg-krause.net> Date: Thu, 29 Sep 2022 15:36:14 +0200 Subject: [PATCH] docs(contribute): Document how to do a release --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index cc5417d..c91a8b7 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. -- GitLab