From 8909a4d18ce8fff1731c5e55816c516fc585ad84 Mon Sep 17 00:00:00 2001 From: decitre <590094+decitre@users.noreply.github.com> Date: Wed, 7 Feb 2024 11:05:15 +0100 Subject: [PATCH] Enhance CONTRIBUTING about releasing details --- CONTRIBUTING.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82ceca9..34509e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,9 +31,21 @@ If dev branch `test` workflow succeed, a new version can be released. 2. Merge - To `master` + To `main` 3. Publish - Publishing to PyPi is done through the creation of a release in Github UI. - Choose the tag created in step 1, then "Publish release". + Publishing to PyPi is done through the creation of a release in the [Github UI](https://github.com/decitre/python-proto-topy/releases): + - "Draft a new release" + - Choose the tag created in step 1 + - Use it to name the release + - Add the changes to the description field + - "Publish release" + - Check the `release` [action](https://github.com/decitre/python-proto-topy/actions/workflows/release.yml) + +4. Install published package + + In a dedicated `venv`, do: + + pip install proto_topy== + python -c "import proto_topy as pt; print(pt.__version__, pt.ProtoCollection().compiler_version())"