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