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