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.2.0] - 3/3/2020
  18 -------------------
  19 ::
  20
  21     * now allows for RMR Xapps to call code before entering the infinite loop
  22     * 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
  23     * stop now calls rmr_close to correctly free up any port(s)
  24     * (breaking) renames `loop` to `entrypoint` since the function does not have to contain a loop (though it most likely does)
  25     * Changes wording around the two types of xapps (docs only)
  26     * 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
  27     * more unit test code coverage
  28     * Adds more fields to setup like long_desc and classifiers so the pypi page looks nicer
  29     * Removes a bad release file (will be added back in subseq. commit)
  30
  31 [0.1.0] - 2/27/2020
  32 -------------------
  33 ::
  34
  35     * Initial commit