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 [0.6.0] - 3/23/2020
  18 -------------------
  19 ::
  20
  21     * Switch to SI95 for rmr
  22
  23
  24
  25 [0.5.0] - 3/18/2020
  26 -------------------
  27 ::
  28
  29     * All xapps (via the base class) now have a logger attribute that can be invoked to provide mdc logging. It is a passthrough to the RIC mdc logger for python (untouched, no value in an API on top at the current time).
  30
  31
  32 [0.4.1] - 3/17/2020
  33 -------------------
  34 ::
  35
  36     * Switch tox to use py38
  37     * switch to latest builders
  38
  39
  40 [0.4.0] - 3/13/2020
  41 -------------------
  42 ::
  43
  44     * minor breaking change; switches the default behavior RE threading for RMRXapps. The default is not to return execution, but the caller (in `run`) can choose to loop in a thread.
  45     * Add Dockerized examples
  46
  47
  48 [0.3.0] - 3/10/2020
  49 -------------------
  50 ::
  51
  52     * Large change to the "feel" of this framework: rather than subclass instantiation, xapps now use initialization and registration functions to register handlers
  53     * rmr xapps can now register handlers for specific message types (and they must prodive a default callback); if the user does this then "message to function routing" is now handled by the framework itself
  54     * RMRXapp now runs the polling loop in a thread, and returns execution back to the caller. The user is then free to loop, or do nothing, and call stop() when they want.
  55     * Raises tox coverage minimum to 70 from 50 (currently at 86)
  56
  57 [0.2.0] - 3/3/2020
  58 -------------------
  59 ::
  60
  61     * now allows for RMRXapps to call code before entering the infinite loop
  62     * stop is now called before throwing NotImplemented in the case where the client fails to provide a must have callback; this ensures there is no dangling rmr thread
  63     * stop now calls rmr_close to correctly free up any port(s)
  64     * (breaking) renames `loop` to `entrypoint` since the function does not have to contain a loop (though it most likely does)
  65     * Changes wording around the two types of xapps (docs only)
  66     * Uses a new version of rmr python that crashes when the rmr mrc fails to init, which prevents an xapp trying to use an unusable rmr
  67     * more unit test code coverage
  68     * Adds more fields to setup like long_desc and classifiers so the pypi page looks nicer
  69     * Removes a bad release file (will be added back in subseq. commit)
  70
  71 [0.1.0] - 2/27/2020
  72 -------------------
  73 ::
  74
  75     * Initial commit