From f563e833611d93480623e1079a33ffe503c4cf74 Mon Sep 17 00:00:00 2001 From: Tor-Einar Skog <tor-einar.skog@nibio.no> Date: Mon, 13 Feb 2023 15:41:42 +0100 Subject: [PATCH] Adding bumpver info --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 8a3af2d..1eec9f5 100644 --- a/README.md +++ b/README.md @@ -31,5 +31,17 @@ To run the unit tests, move to the root folder of the project, and execute: pytest -v ``` +### Using bumpver +For developers: When you want to publish a new version, use +``` bash +# Increment the PATCH version when you make backwards compatible bug fixes. +bumpver update --patch +# Increment the MINOR version when you add functionality in a backwards compatible manner. +bumpver update --minor +# Increment the MAJOR version when you make incompatible API changes. +bumpver update --major +``` +[(Source)](https://semver.org/#summary) + ## References We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/ \ No newline at end of file -- GitLab