b39538e93b93d4b357919d4cbefad14474c02f49
[ric-plt/sdlgo.git] / docs / release-notes.rst
1 ..
2 ..  Copyright (c) 2019 AT&T Intellectual Property.
3 ..  Copyright (c) 2019-2022 Nokia.
4 ..
5 ..  Licensed under the Creative Commons Attribution 4.0 International
6 ..  Public License (the "License"); you may not use this file except
7 ..  in compliance with the License. You may obtain a copy of the License at
8 ..
9 ..    https://creativecommons.org/licenses/by/4.0/
10 ..
11 ..  Unless required by applicable law or agreed to in writing, documentation
12 ..  distributed under the License is distributed on an "AS IS" BASIS,
13 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 ..
15 ..  See the License for the specific language governing permissions and
16 ..  limitations under the License.
17 ..
18
19 Release-Notes
20 =============
21
22 This document provides the release notes of the sdlgo.
23
24 .. contents::
25    :depth: 3
26    :local:
27
28
29
30 Version history
31 ---------------
32
33 [0.10.2] - 2022-09-30
34
35 * Fix Coverity issues about missing function call return value validations
36
37 [0.10.1] - 2022-08-12
38
39 * Upgrade Golang version to 1.18 in ci Dockerfile
40
41 [0.10.0] - 2022-03-14
42
43 * Enable redis/sentinel port and sentinel master name configuration
44
45 [0.9.6] - 2022-02-07
46
47 * Fix multi-namespace SDL event subscribe
48
49 [0.9.5] - 2022-01-20
50
51 * Pump Redis client version to v8.11.4 and fix Redis APIs to have a Golang
52   Context type of argument.
53
54 [0.9.4] - 2022-01-12
55
56 * SDL CLI command to generate sdlcli shell completion file for bash
57
58 [0.9.3] - 2021-12-30
59
60 * Fix SDL CLI get -command to write results stdout stream when command success
61
62 [0.9.2] - 2021-12-22
63
64 * Fix SDL CLI healthcheck to ignore ghost Redis Sentinel entries
65
66 [0.9.1] - 2021-12-20
67
68 * Refactor and reduce code complexity, no API changes
69 * Validate namespace argument in SDL CLI get keys -command
70
71 [0.9.0] - 2021-12-16
72
73 * SDL CLI tool
74
75 [0.8.0] - 2021-09-22
76
77 * New ListKeys API in syncstorage
78 * Add deprecation warnings for SdlInstance APIs
79
80 [0.7.0] - 2021-05-11
81
82 * Add DB backend instance selection based on namespace value to balance DB load.
83
84 [0.6.0] - 2021-05-11
85
86 * Add SDL multi-namespace API 'SyncStorage'.
87
88 [0.5.5] - 2021-03-09
89
90 * Take DBAAS multi-channel publishing Redis modules into use.
91 * Fix potential type conversion crash in RemoveIf() and
92   RemoveIfAndPublish() APIs.
93
94 [0.5.4] - 2020-10-07
95
96 * Fix Go routine race condition when new DB notifications are subscribed.
97
98 [0.5.3] - 2020-08-17
99
100 * Take Redis client version 6.15.9 into use.
101
102 [0.5.1] - 2019-11-1
103
104 * Add CI Dockerfile to run unit tests.
105
106 [0.5.0] - 2019-10-11
107
108 * Make underlying DB instance visible to clients.
109
110 [0.4.0] - 2019-09-26
111
112 * Add support for Redis sentinel configuration.
113
114 [0.3.1] - 2019-09-11
115
116 * Set MaxRetries count to 2 for Redis client.
117
118 [0.3.0] - 2019-08-14
119
120 * Add support for resource locking to enable applications to create locks for
121   shared resources.
122
123 [0.2.1] - 2019-07-03
124
125 * Add support for multiple event publishing.
126
127 [0.2.0] - 2019-05-24
128
129 * Add support for SDL groups.
130
131 [0.1.1] - 2019-05-17
132
133 * Allow byte array/slice be given as value.
134
135 [0.1.0] - 2019-05-17
136
137 * Add support for notifications.
138
139 [0.0.2] - 2019-05-03
140
141 * Fix Close API call. Calling Close function from API caused a recursive call
142   to itself.
143
144 [0.0.1] - 2019-04-17
145
146 * Initial version.
147 * Implement basic storage functions to create, read, update, and delete
148   entries.
149 * Implement benchmark tests.