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