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