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