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