This is an automated email from the ASF dual-hosted git repository. jfeinauer pushed a commit to branch feature/improve-py-logging in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit c4bad5839fa6e0578d87fb354bec235eeba0bb22 Author: Julian Feinauer <[email protected]> AuthorDate: Sun Apr 4 10:58:49 2021 +0200 [CLIENT-PY] Improved Release Documentation. --- client-py/README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/client-py/README.md b/client-py/README.md index c2e03cb..2b80057 100644 --- a/client-py/README.md +++ b/client-py/README.md @@ -190,4 +190,20 @@ Both can be run by `black .` or `flake8 .` respectively. To do a release just ensure that you have the right set of generated thrift files. Then run linting and auto-formatting. Then, ensure that all tests work (via `pytest .`). -Then you are good to go to do a release! \ No newline at end of file +Then you are good to go to do a release! + +### Preparing your environment + +First, install all necessary dev dependencies via `pip install -r requirements_dev.txt`. + +### Doing the Release + +There is a convenient script `release.sh` to do all steps for a release. +Namely, these are + +* Remove all transient directories from last release (if exists) +* (Re-)generate all generated sources via mvn +* Run Linting (flake8) +* Run Tests via pytest +* Build +* Release to pypi
