Change package to semantic versioning and indicate stable

andrewtavis · Dec 28, 2021 · 1b281d7 · 1b281d7
1 parent 5c8c515
commit 1b281d7
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,16 @@
-### wikirec 0.2.2 (May 20, 2021)
+# Changelog
+
+wikirec tries to follow [semantic versioning](https://semver.org/), a MAJOR.MINOR.PATCH version where increments are made of the:
+
+- MAJOR version when we make incompatible API changes
+- MINOR version when we add functionality in a backwards compatible manner
+- PATCH version when we make backwards compatible bug fixes
+
+# wikirec 1.0.0 (December 28th, 2021)
+
+- Release switches wikirec over to [semantic versioning](https://semver.org/) and indicates that it is stable
+
+# wikirec 0.2.2 (May 20th, 2021)
 
 Changes include:
 
@@ -9,15 +21,15 @@ Changes include:
 - Function docstring grammar fixes
 - Baseline testing for the new model has been added to the CI
 
-### wikirec 0.2.1 (April 29, 2021)
+# wikirec 0.2.1 (April 29th, 2021)
 
 Changes include:
 
 - Support has been added for gensim 3.8.x and 4.x
 - Wikipedia links are now an output of data_utils.parse_to_ndjson
 - Dependencies in requirement and environment files are now condensed
 
-### wikirec 0.2.0 (April 16, 2021)
+# wikirec 0.2.0 (April 16th, 2021)
 
 Changes include:
 
@@ -29,7 +41,7 @@ Changes include:
 - Bug fixes and a more explicit use of exceptions
 - More extensive contributing guidelines
 
-### wikirec 0.1.1.7 (March 14, 2021)
+# wikirec 0.1.1.7 (March 14th, 2021)
 
 Changes include:
 
@@ -39,7 +51,7 @@ Changes include:
 - The workflow for all models has been improved and explained
 - Methods have been developed to combine modeling techniques for better results
 
-### wikirec 0.1.0 (March 8, 2021)
+# wikirec 0.1.0 (March 8th, 2021)
 
 First stable release of wikirec
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,7 +24,7 @@
 author = "wikirec developers"
 
 # The full version, including alpha/beta/rc tags
-release = "0.2.2.2"
+release = "1.0.0"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/setup.py b/setup.py
@@ -14,7 +14,7 @@
     name="wikirec",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
-    version="0.2.2.2",
+    version="1.0.0",
     author="Andrew Tavis McAllister",
     author_email="andrew.t.mcallister@gmail.com",
     classifiers=[