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