RMR update and I release step 1 of 2
[ric-plt/xapp-frame-py.git] / docs / release-notes.rst
index 3ae4794..c2ca26a 100644 (file)
@@ -10,9 +10,113 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 
-.. contents::
-   :depth: 3
-   :local:
+[3.2.3] - 2023-12-13
+--------------------
+* update RMR version to 4.9.4
+
+[3.2.2] - 2023-06-08
+--------------------
+* update RMR version to 4.9.1
+
+[3.2.1] - 2022-12-12
+--------------------
+* small permission fix in python init files
+
+[3.2.0] - 2022-06-16
+--------------------
+* Added REST E2 subscription support
+* rnib enhancements
+* REST service with health and config interface
+
+[3.1.0] - 2022-03-22
+--------------------
+* Added the symptomdata module
+
+[3.0.2] - 2021-12-17
+--------------------
+* Fix caching of error code data not happening (`RIC-862 <https://jira.o-ran-sc.org/browse/RIC-862>`_)
+* Improves performance of xapp-frame-py by caching the mapping dict of error codes.
+
+[3.0.1] - 2021-12-07
+--------------------
+* Take configuration and rmr unit tests back into use after fixing the tests (`RIC-865 <https://jira.o-ran-sc.org/browse/RIC-865>`_)
+* Improve memory leak fix done in the version 3.0.0 to free memory also if python exception has been thrown.
+
+[3.0.0] - 2021-12-03
+--------------------
+* Upgrade to RMR version 4.8.0 to fix memory leak in get_constants() function (`RIC-858 <https://jira.o-ran-sc.org/browse/RIC-858>`_)
+* From xapp-frame-py version 3.0.0 onwards it is required to have RMR version 4.8.0 or newer.
+
+[2.3.0] - 2021-09-15
+--------------------
+* Add Xapp Registration (`RIC-706 <https://jira.o-ran-sc.org/browse/RIC-706>`_)
+* Integrate pylog (https://gerrit.o-ran-sc.org/r/admin/repos/com/pylog) with xapp-frame-py (`RIC-330 <https://jira.o-ran-sc.org/browse/RIC-330>`_)
+
+[2.2.0] - 2021-06-23
+--------------------
+* Add E2AP package (`RIC-664 <https://jira.o-ran-sc.org/browse/RIC-664>`_)
+
+
+[2.1.0] - 2021-06-18
+--------------------
+* Add `RNIB <https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/nodeb-rnib>`_ feature (`RIC-788 <https://jira.o-ran-sc.org/browse/RIC-788>`_)
+
+
+[2.0.0] - 2021-06-14
+--------------------
+* Add Xapp registration/deregistration APIs (`RIC-706 <https://jira.o-ran-sc.org/browse/RIC-706>`_)
+* Upgrade SDL 3.0.0 version, SDL scaling (`RIC-699 <https://jira.o-ran-sc.org/browse/RIC-699>`_)
+* Upgrade SDL 3.0.0 version, notification fix (`RIC-795 <https://jira.o-ran-sc.org/browse/RIC-795>`_)
+
+
+[1.6.0] - 2020-10-23
+--------------------
+* Add SDL wrapping API (`RIC-659 <https://jira.o-ran-sc.org/browse/RIC-659>`_)
+
+
+[1.5.0] - 2020-07-10
+--------------------
+* Add Metrics API (`RIC-381 <https://jira.o-ran-sc.org/browse/RIC-381>`_)
+
+
+[1.4.0] - 2020-07-06
+--------------------
+* Revise Alarm manager to send via RMR wormhole (`RIC-529 <https://jira.o-ran-sc.org/browse/RIC-529>`_)
+
+
+[1.3.0] - 2020-06-24
+--------------------
+* Add configuration-change API (`RIC-425 <https://jira.o-ran-sc.org/browse/RIC-425>`_)
+
+
+[1.2.1] - 2020-06-22
+--------------------
+* Revise alarm message type (`RIC-514 <https://jira.o-ran-sc.org/browse/RIC-514>`_)
+
+
+[1.2.0] - 2020-06-04
+--------------------
+* Extend RMR module to support wormhole methods
+* Add alarm API (`RIC-380 <https://jira.o-ran-sc.org/browse/RIC-380>`_)
+
+
+[1.1.2] - 2020-05-13
+--------------------
+* Extend and publish class and method documentation as user guide in RST
+
+
+[1.1.1] - 2020-05-07
+--------------------
+* Use timeout on queue get method to avoid 100% CPU usage (`RIC-354 <https://jira.o-ran-sc.org/browse/RIC-354>`_)
+* Upgrade to RMR version 4.0.5
+
+
+[1.1.0] - 2020-05-06
+--------------------
+* Use RMR timeout on receive to avoid 100% CPU usage (`RIC-354 <https://jira.o-ran-sc.org/browse/RIC-354>`_)
+* Publish message-summary dict keys as constants to avoid hardcoding strings
+* Add wrapper and test for RMR method rmr_set_vlevel(int)
+
 
 [1.0.3] - 2020-04-29
 --------------------
@@ -26,7 +130,6 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 
 [1.0.1] - 2020-04-10
 --------------------
-
 * Publish API documentation using Sphinx autodoc, which required
   changes so Sphinx can run when the RMR .so file is not available,
   such as during a ReadTheDocs build.
@@ -42,7 +145,6 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 
 [1.0.0] - 4/6/2020
 ------------------
-
 * Python rmr has been moved into this repo. The module name has NOT
   changed in order to make the transition for repos very easy. The
   only transition needed should be prefixing rmr with ricxappframe in
@@ -51,7 +153,6 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 
 [0.7.0] - 4/2/2020
 ------------------
-
 * RMRXapps by default now implement the rmr healthcheck probe;
   users can also override it with a more complex handler if they
   wish
@@ -61,14 +162,11 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 
 [0.6.0] - 3/23/2020
 -------------------
-
 * Switch to SI95 for rmr
 
 
-
 [0.5.0] - 3/18/2020
 -------------------
-
 * All xapps (via the base class) now have a logger attribute that can
   be invoked to provide mdc logging. It is a passthrough to the RIC
   mdc logger for python (untouched, no value in an API on top at the
@@ -77,14 +175,12 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 
 [0.4.1] - 3/17/2020
 -------------------
-
 * Switch tox to use py38
 * switch to latest builders
 
 
 [0.4.0] - 3/13/2020
 -------------------
-
 * Minor breaking change; switches the default behavior RE
   threading for RMRXapps. The default is not to return execution,
   but the caller (in `run`) can choose to loop in a thread.
@@ -93,7 +189,6 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
 
 [0.3.0] - 3/10/2020
 -------------------
-
 * Large change to the "feel" of this framework: rather than subclass
   instantiation, xapps now use initialization and registration
   functions to register handlers
@@ -105,9 +200,9 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
   and call stop() when they want.
 * Raises tox coverage minimum to 70 from 50 (currently at 86)
 
+
 [0.2.0] - 3/3/2020
 ------------------
-
 * now allows for RMRXapps to call code before entering the infinite
   loop
 * stop is now called before throwing NotImplemented in the case where
@@ -124,7 +219,7 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
   page looks nicer
 * Removes a bad release file (will be added back in subseq. commit)
 
+
 [0.1.0] - 2/27/2020
 -------------------
-
 * Initial commit