docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2020 AT&T Intellectual Property
   4
   5 Release Notes
   6 =============
   7
   8 All notable changes to this project will be documented in this file.
   9
  10 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
  11 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
  12
  13 [3.0.2] - 2021-12-17
  14 --------------------
  15 * Fix caching of error code data not happening (`RIC-862 <https://jira.o-ran-sc.org/browse/RIC-862>`_)
  16 * Improves performance of xapp-frame-py by caching the mapping dict of error codes.
  17
  18 [3.0.1] - 2021-12-07
  19 --------------------
  20 * Take configuration and rmr unit tests back into use after fixing the tests (`RIC-865 <https://jira.o-ran-sc.org/browse/RIC-865>`_)
  21 * Improve memory leak fix done in the version 3.0.0 to free memory also if python exception has been thrown.
  22
  23 [3.0.0] - 2021-12-03
  24 --------------------
  25 * 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>`_)
  26 * From xapp-frame-py version 3.0.0 onwards it is required to have RMR version 4.8.0 or newer.
  27
  28 [2.3.0] - 2021-09-15
  29 --------------------
  30 * Add Xapp Registration (`RIC-706 <https://jira.o-ran-sc.org/browse/RIC-706>`_)
  31 * 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>`_)
  32
  33 [2.2.0] - 2021-06-23
  34 --------------------
  35 * Add E2AP package (`RIC-664 <https://jira.o-ran-sc.org/browse/RIC-664>`_)
  36
  37
  38 [2.1.0] - 2021-06-18
  39 --------------------
  40 * 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>`_)
  41
  42
  43 [2.0.0] - 2021-06-14
  44 --------------------
  45 * Add Xapp registration/deregistration APIs (`RIC-706 <https://jira.o-ran-sc.org/browse/RIC-706>`_)
  46 * Upgrade SDL 3.0.0 version, SDL scaling (`RIC-699 <https://jira.o-ran-sc.org/browse/RIC-699>`_)
  47 * Upgrade SDL 3.0.0 version, notification fix (`RIC-795 <https://jira.o-ran-sc.org/browse/RIC-795>`_)
  48
  49
  50 [1.6.0] - 2020-10-23
  51 --------------------
  52 * Add SDL wrapping API (`RIC-659 <https://jira.o-ran-sc.org/browse/RIC-659>`_)
  53
  54
  55 [1.5.0] - 2020-07-10
  56 --------------------
  57 * Add Metrics API (`RIC-381 <https://jira.o-ran-sc.org/browse/RIC-381>`_)
  58
  59
  60 [1.4.0] - 2020-07-06
  61 --------------------
  62 * Revise Alarm manager to send via RMR wormhole (`RIC-529 <https://jira.o-ran-sc.org/browse/RIC-529>`_)
  63
  64
  65 [1.3.0] - 2020-06-24
  66 --------------------
  67 * Add configuration-change API (`RIC-425 <https://jira.o-ran-sc.org/browse/RIC-425>`_)
  68
  69
  70 [1.2.1] - 2020-06-22
  71 --------------------
  72 * Revise alarm message type (`RIC-514 <https://jira.o-ran-sc.org/browse/RIC-514>`_)
  73
  74
  75 [1.2.0] - 2020-06-04
  76 --------------------
  77 * Extend RMR module to support wormhole methods
  78 * Add alarm API (`RIC-380 <https://jira.o-ran-sc.org/browse/RIC-380>`_)
  79
  80
  81 [1.1.2] - 2020-05-13
  82 --------------------
  83 * Extend and publish class and method documentation as user guide in RST
  84
  85
  86 [1.1.1] - 2020-05-07
  87 --------------------
  88 * Use timeout on queue get method to avoid 100% CPU usage (`RIC-354 <https://jira.o-ran-sc.org/browse/RIC-354>`_)
  89 * Upgrade to RMR version 4.0.5
  90
  91
  92 [1.1.0] - 2020-05-06
  93 --------------------
  94 * Use RMR timeout on receive to avoid 100% CPU usage (`RIC-354 <https://jira.o-ran-sc.org/browse/RIC-354>`_)
  95 * Publish message-summary dict keys as constants to avoid hardcoding strings
  96 * Add wrapper and test for RMR method rmr_set_vlevel(int)
  97
  98
  99 [1.0.3] - 2020-04-29
 100 --------------------
 101 * Upgrade to RMR version 4.0.2
 102
 103
 104 [1.0.2] - 2020-04-22
 105 --------------------
 106 * Upgrade to RMR version 3.8.0
 107
 108
 109 [1.0.1] - 2020-04-10
 110 --------------------
 111 * Publish API documentation using Sphinx autodoc, which required
 112   changes so Sphinx can run when the RMR .so file is not available,
 113   such as during a ReadTheDocs build.
 114 * Create new subpackage rmr/rmrclib with the C library loaded via
 115   ctypes.
 116 * Extend sphinx configuration to mock the new rmrclib subpackage
 117 * Add method to get constants from RMR library and detect mock
 118   objects to work around a bug in Sphinx 3.0.0.
 119 * Split test files into test_rmr and test_rmrclib.
 120 * Add function to define argtype and restype values for library functions
 121 * Configure intersphinx link for RMR man pages at ReadTheDocs.io
 122
 123
 124 [1.0.0] - 4/6/2020
 125 ------------------
 126 * Python rmr has been moved into this repo. The module name has NOT
 127   changed in order to make the transition for repos very easy. The
 128   only transition needed should be prefixing rmr with ricxappframe in
 129   import statements, and to include this rather than rmr in setup.
 130
 131
 132 [0.7.0] - 4/2/2020
 133 ------------------
 134 * RMRXapps by default now implement the rmr healthcheck probe;
 135   users can also override it with a more complex handler if they
 136   wish
 137 * Fix a bug in the unit tests where a payload mismatch wouldn't
 138   actually fail the test (would now)
 139
 140
 141 [0.6.0] - 3/23/2020
 142 -------------------
 143 * Switch to SI95 for rmr
 144
 145
 146 [0.5.0] - 3/18/2020
 147 -------------------
 148 * All xapps (via the base class) now have a logger attribute that can
 149   be invoked to provide mdc logging. It is a passthrough to the RIC
 150   mdc logger for python (untouched, no value in an API on top at the
 151   current time).
 152
 153
 154 [0.4.1] - 3/17/2020
 155 -------------------
 156 * Switch tox to use py38
 157 * switch to latest builders
 158
 159
 160 [0.4.0] - 3/13/2020
 161 -------------------
 162 * Minor breaking change; switches the default behavior RE
 163   threading for RMRXapps. The default is not to return execution,
 164   but the caller (in `run`) can choose to loop in a thread.
 165 * Add Dockerized examples
 166
 167
 168 [0.3.0] - 3/10/2020
 169 -------------------
 170 * Large change to the "feel" of this framework: rather than subclass
 171   instantiation, xapps now use initialization and registration
 172   functions to register handlers
 173 * rmr xapps can now register handlers for specific message types (and
 174   they must prodive a default callback); if the user does this then
 175   "message to function routing" is now handled by the framework itself
 176 * RMRXapp now runs the polling loop in a thread, and returns execution
 177   back to the caller. The user is then free to loop, or do nothing,
 178   and call stop() when they want.
 179 * Raises tox coverage minimum to 70 from 50 (currently at 86)
 180
 181
 182 [0.2.0] - 3/3/2020
 183 ------------------
 184 * now allows for RMRXapps to call code before entering the infinite
 185   loop
 186 * stop is now called before throwing NotImplemented in the case where
 187   the client fails to provide a must have callback; this ensures there
 188   is no dangling rmr thread
 189 * stop now calls rmr_close to correctly free up any port(s)
 190 * (breaking) renames `loop` to `entrypoint` since the function does
 191   not have to contain a loop (though it most likely does)
 192 * Changes wording around the two types of xapps (docs only)
 193 * Uses a new version of rmr python that crashes when the rmr mrc fails
 194   to init, which prevents an xapp trying to use an unusable rmr
 195 * more unit test code coverage
 196 * Adds more fields to setup like long_desc and classifiers so the pypi
 197   page looks nicer
 198 * Removes a bad release file (will be added back in subseq. commit)
 199
 200
 201 [0.1.0] - 2/27/2020
 202 -------------------
 203 * Initial commit