Implement healthcheck handler

[ric-plt/xapp-frame-py.git] / docs / release-notes.rst

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 37e7c70..46de054 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -14,6 +14,68 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
    :depth: 3
    :local:
 
+[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
+    * Fix a bug in the unit tests where a payload mismatch wouldn't actually fail the test (would now)
+
+
+[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 current time).
+
+
+[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.
+    * Add Dockerized examples
+
+
+[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
+    * rmr xapps can now register handlers for specific message types (and they must prodive a default callback); if the user does this then "message to function routing" is now handled by the framework itself
+    * RMRXapp now runs the polling loop in a thread, and returns execution back to the caller. The user is then free to loop, or do nothing, 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 the client fails to provide a must have callback; this ensures there is no dangling rmr thread
+    * stop now calls rmr_close to correctly free up any port(s)
+    * (breaking) renames `loop` to `entrypoint` since the function does not have to contain a loop (though it most likely does)
+    * Changes wording around the two types of xapps (docs only)
+    * Uses a new version of rmr python that crashes when the rmr mrc fails to init, which prevents an xapp trying to use an unusable rmr
+    * more unit test code coverage
+    * Adds more fields to setup like long_desc and classifiers so the pypi page looks nicer
+    * Removes a bad release file (will be added back in subseq. commit)
+
 [0.1.0] - 2/27/2020
 -------------------
 ::