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