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