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