Make changes for releasing v2.3.4
[ric-plt/xapp-frame-cpp.git] / docs / rel-notes.rst
1 =============
2 RELEASE NOTES
3 =============
4 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
5 .. SPDX-License-Identifier: CC-BY-4.0
6 ..
7 .. CAUTION: this document is generated from source in doc/src/*
8 .. To make changes edit the source and recompile the document.
9 .. Do NOT make changes directly to .rst or .md files.
10
11
12
13 C++ Framework Release Notes
14 ===========================
15 The following is a list of release highlights for the C++
16 xAPP Framework.
17
18 Dawn Release
19 ============
20
21 2021 23 June; version 2.3.4
22 ---------------------------
23 Taking in new RMR version 4.7.4 that contains many bug fixes.
24
25 Cherry Release
26 ==============
27
28 2020 11 December; version 2.3.3
29 -------------------------------
30 Version bump to force CI jobs to promote the packages.
31
32
33 2020 21 August; version 2.3.2
34 -----------------------------
35 Small cleanup of "code smells" and add additional test stats
36 to unit tests.
37
38
39 2020 21 August; version 2.3.1
40 -----------------------------
41 Fix bug in message introduced with "code smell" fix.
42 (RIC-629)
43
44
45 2020 20 August; version 2.3.0
46 -----------------------------
47 Address sonar flagged "bugs" in the config class (RIC-629).
48
49
50 2020 13 August; version 2.2.2
51 -----------------------------
52 Correct potential memory leaks in xapp class (RIC-629)
53
54
55 2020 July 31; version 2.2.1
56 ---------------------------
57 Correct "bugs" according to sonar (RIC-629)
58
59
60 2020 July 30; version 2.2.0
61 ---------------------------
62 Add support for configuration file reading and change
63 notification.
64
65
66 2020 July 22; version 2.1.0
67 ---------------------------
68 Added metrics support (RIC-381).
69
70
71 2020 July 17; version 2.0.0
72 ---------------------------
73 Add alarm support.
74
75 Add xapp namespace for Message, Msg_component, Alarm and Jhah
76 objects. This is a BREAKING change and thus the major version
77 number was bumped to 2.
78
79
80 2020 June 29; version 1.2.0
81 ---------------------------
82 Add support for json parsing
83
84
85 2020 June 26; version 1.1.0
86 ---------------------------
87 Change the port type in constructors to indicate "const"
88
89 Version bump to 1.1.0 to allow patches to bronze code to
90 continue to be done on the 1.0.* level.
91
92
93
94 Bronze Release
95 ==============
96
97 2020 April 28; version 1.0.0
98 ----------------------------
99 Bump version to force package build (old CI version added
100 incorrect install prefix). Bump to 1.0.0 for release.
101
102
103 2020 March 27; version 0.1.2
104 ----------------------------
105 Changes identified by sonar (missing copy/move builders)
106 rmr_dump example programme Improvements to code for better
107 test coverage