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