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