H release step 1 of 2
[ric-plt/sdlpy.git] / docs / release-notes.rst
index 92a49a6..c1aa976 100644 (file)
@@ -1,6 +1,6 @@
 ..
 ..  Copyright (c) 2019 AT&T Intellectual Property.
-..  Copyright (c) 2019 Nokia.
+..  Copyright (c) 2019-2022 Nokia.
 ..
 ..  Licensed under the Creative Commons Attribution 4.0 International
 ..  Public License (the "License"); you may not use this file except
@@ -33,6 +33,78 @@ This document provides the release notes of the ricsdl library.
 Version history
 ---------------
 
+[3.1.3] - 2023-06-08
+
+* Bump Python version to 3.9.
+
+[3.1.2] - 2022-12-12
+
+* correcting whitespaces
+
+[3.1.1] - 2022-06-27
+
+* Bump Python version to 3.8.
+
+[3.1.0] - 2022-03-14
+
+* Enable redis/sentinel port and sentinel master name configuration
+
+[3.0.2] - 2022-01-20
+
+* Bump Redis client version to 4.1.1 and replace deprecated Redis client '_compat'
+  module with 'utils' module.
+
+[3.0.1] - 2021-11-18
+
+* Add specific package versions for required dependencies: redis==3.5.3 and
+* hiredis==2.0.0. Package ricsdl is not compatible with new redis 4.x.y versions.
+
+[3.0.0] - 2021-06-10
+
+* Simplify v2.3.0 notification callback and handle_events API to return received
+  event(s) only as a list type. Earlier single event was returned as a string type.
+  Notification callback and handle_events API changes are not backward compatible.
+
+[2.3.0] - 2021-06-09
+
+* Pack all the events in a channel to one DB notification to be in line with SDL Golang.
+
+[2.2.0] - 2021-05-11
+
+* Add DB backend instance selection based on namespace value to balance DB load.
+
+[2.1.1] - 2021-03-09
+
+* Take DBAAS multi-channel publishing Redis modules into use.
+
+[2.1.0] - 2020-08-26
+
+* Add support for notifications
+
+[2.0.4] - 2020-05-13
+
+* Enhance SDL API set() function argument validation to cover also dictionary items.
+
+[2.0.3] - 2020-01-22
+
+* Add a new SDL storage API function `is_active()` to check healthiness of SDL instance.
+
+[2.0.2] - 2020-01-14
+
+* Version bump.
+
+[2.0.1] - 2020-01-13
+
+* Add a fake database backend implementation to be used only for testing
+  purposes when the real DBAAS database service is not available.
+
+[2.0.0] - 2020-01-03
+
+* Change find_keys() and find_and_get() API functions to support glob-style
+  regular expression in a key search pattern. API backward incompatible change.
+* Remove 'atomic' parameter of find_and_get() API function. API backward
+  incompatible change.
+
 [1.0.2] - 2019-12-18
 
 * Take Hiredis package into use in Redis database backend.
@@ -112,5 +184,3 @@ Workarounds
 
 References
 ----------
-
-