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