diff --git a/.cz.toml b/.cz.toml index 048be1a0..89ebe36c 100644 --- a/.cz.toml +++ b/.cz.toml @@ -1,6 +1,6 @@ [tool.commitizen] name = "cz_conventional_commits" -version = "2.0" +version = "2.0.0" version_files = [ "setup.py", "docs/source/conf.py", diff --git a/README.md b/README.md index 5007c11a..90d6290a 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ What's Changed -Tutorials may be run in your browser using Google Colab +Tutorials may be run in your browser using Google Colab ------------------------------------------------------- **Additional Tutorials may be found on in the Tutorials Folder.** @@ -182,7 +182,7 @@ For an editable installation with access to jupyter notebooks: To install with the tutorials: - >>> pip install -e .['tutorials'] + >>> pip install -e .['tutorials'] To install with the documentation: @@ -317,6 +317,22 @@ gh run list --workflow=ci.yml --repo pnnl/HyperNetX ``` +Versioning +---------------------- + +This project uses [`commitizen`](https://github.com/commitizen-tools/commitizen) to manage versioning. +The files where "version" will be updated are listed in the '.cz.toml' file. To create a new version and the associated tag, +run the following commands: + +```shell +# Install commitizen tool to environment +make releases + +# Updates version; values for '--increment' can be MAJOR, MINOR, or PATCH +# Autocreates a tag and commit for the updated version +cz bump --increment MAJOR --dry-run +cz bump --increment MAJOR +``` Notice ------ diff --git a/hypernetx/__init__.py b/hypernetx/__init__.py index 9db7ab73..406dddbc 100644 --- a/hypernetx/__init__.py +++ b/hypernetx/__init__.py @@ -11,4 +11,4 @@ from hypernetx.utils import * from hypernetx.utils.toys import * -__version__ = "1.2.5" +__version__ = "2.0.0" diff --git a/setup.py b/setup.py index ac46e644..c3288b95 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,5 @@ from setuptools import setup -__version__ = "2.0" +__version__ = "2.0.0" setup(version=__version__)