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