| Tommy Carpenter | 53786ca | 2020-02-28 09:17:46 -0500 | [diff] [blame] | 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 | |
| Tommy Carpenter | 0f8305b | 2020-03-18 10:34:28 -0400 | [diff] [blame^] | 17 | |
| 18 | [0.5.0] - 3/18/2020 |
| 19 | ------------------- |
| 20 | :: |
| 21 | |
| 22 | * 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). |
| 23 | |
| 24 | |
| Tommy Carpenter | 5b582d6 | 2020-03-17 17:41:42 -0400 | [diff] [blame] | 25 | [0.4.1] - 3/17/2020 |
| 26 | ------------------- |
| 27 | :: |
| 28 | |
| 29 | * Switch tox to use py38 |
| 30 | * switch to latest builders |
| 31 | |
| 32 | |
| Tommy Carpenter | 1c9ce6b | 2020-03-13 09:36:36 -0400 | [diff] [blame] | 33 | [0.4.0] - 3/13/2020 |
| 34 | ------------------- |
| 35 | :: |
| 36 | |
| 37 | * 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. |
| Tommy Carpenter | 01533e6 | 2020-03-16 09:29:23 -0400 | [diff] [blame] | 38 | * Add Dockerized examples |
| Tommy Carpenter | 1c9ce6b | 2020-03-13 09:36:36 -0400 | [diff] [blame] | 39 | |
| Tommy Carpenter | f9cd5cc | 2020-03-09 13:46:37 -0400 | [diff] [blame] | 40 | |
| 41 | [0.3.0] - 3/10/2020 |
| 42 | ------------------- |
| 43 | :: |
| 44 | |
| 45 | * Large change to the "feel" of this framework: rather than subclass instantiation, xapps now use initialization and registration functions to register handlers |
| 46 | * 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 |
| 47 | * 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. |
| 48 | * Raises tox coverage minimum to 70 from 50 (currently at 86) |
| 49 | |
| Tommy Carpenter | 99a0b48 | 2020-03-03 10:21:24 -0500 | [diff] [blame] | 50 | [0.2.0] - 3/3/2020 |
| 51 | ------------------- |
| 52 | :: |
| 53 | |
| Tommy Carpenter | f9cd5cc | 2020-03-09 13:46:37 -0400 | [diff] [blame] | 54 | * now allows for RMRXapps to call code before entering the infinite loop |
| Tommy Carpenter | 99a0b48 | 2020-03-03 10:21:24 -0500 | [diff] [blame] | 55 | * 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 |
| 56 | * stop now calls rmr_close to correctly free up any port(s) |
| 57 | * (breaking) renames `loop` to `entrypoint` since the function does not have to contain a loop (though it most likely does) |
| 58 | * Changes wording around the two types of xapps (docs only) |
| 59 | * 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 |
| 60 | * more unit test code coverage |
| 61 | * Adds more fields to setup like long_desc and classifiers so the pypi page looks nicer |
| 62 | * Removes a bad release file (will be added back in subseq. commit) |
| 63 | |
| Tommy Carpenter | 53786ca | 2020-02-28 09:17:46 -0500 | [diff] [blame] | 64 | [0.1.0] - 2/27/2020 |
| 65 | ------------------- |
| 66 | :: |
| 67 | |
| 68 | * Initial commit |