Skip to content

Commit 2ba43f7

Browse files
authored
[ADV-89] Highlight breaking changes in CHANGELOG (#375)
* Highlight breaking changes in CHANGELOG Updated CHANGELOG to highlight breaking changes for 20.x.x to 23.x.x.
1 parent bc7219d commit 2ba43f7

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

CHANGELOG.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -62,29 +62,33 @@ All notable changes to this project will be documented in this file.
6262

6363
## [23.0.0] - 2023-02-08
6464

65+
### Breaking Changes
66+
- Removed `Timeout` from `EventStoreOperationOptions` and moved it to an explicit `deadline` parameter on all operations except for subscriptions. Consequently, `configureOperationOptions` callback has been removed for most operations. [EventStore-Client-Dotnet#194](https://github.com/EventStore/EventStore-Client-Dotnet/pull/194)
67+
- Drop support for `netcoreapp3.1` [EventStore-Client-Dotnet#204](https://github.com/EventStore/EventStore-Client-Dotnet/pull/204)
68+
6569
### Added
66-
- Allow channels to open extra connections if they reach the max streams per connection limit (i.e. too may concurrent grpc calls- 100 by default) [EventStore-Client-Dotnet#21q8](https://github.com/EventStore/EventStore-Client-Dotnet/pull/218)
70+
- Allow channels to open extra connections if they reach the max streams per connection limit (i.e. too may concurrent grpc calls- 100 by default) [EventStore-Client-Dotnet#218](https://github.com/EventStore/EventStore-Client-Dotnet/pull/218)
6771
- Correct the error message when deleting a stream using gRPC. [EventStore-Client-Dotnet#221](https://github.com/EventStore/EventStore-Client-Dotnet/pull/221)
6872
- Support `List()` over gRPC for listing persistent subscriptions [EventStore-Client-Dotnet#180](https://github.com/EventStore/EventStore-Client-Dotnet/pull/180)
6973
- Support `ReplayParked()` over gRPC for replaying parked messages [EventStore-Client-Dotnet#180](https://github.com/EventStore/EventStore-Client-Dotnet/pull/180)
7074
- Support `GetInfo()` over gRPC for returning details of a persistent subscription [EventStore-Client-Dotnet#180](https://github.com/EventStore/EventStore-Client-Dotnet/pull/180)
7175
- Target `net6.0` [EventStore-Client-Dotnet#204](https://github.com/EventStore/EventStore-Client-Dotnet/pull/204)
7276
- Target `net7.0` [EventStore-Client-Dotnet#230](https://github.com/EventStore/EventStore-Client-Dotnet/pull/230)
7377

74-
### Changed
75-
- Removed `Timeout` from `EventStoreOperationOptions` and moved it to an explicit `deadline` parameter on all operations except for subscriptions. Consequently, `configureOperationOptions` callback has been removed for most operations. [EventStore-Client-Dotnet#194](https://github.com/EventStore/EventStore-Client-Dotnet/pull/194)
76-
7778
### Fixed
7879
- Incorrect error message when deleting a stream using gRPC [EventStore-Client-Dotnet#221](https://github.com/EventStore/EventStore-Client-Dotnet/pull/221)
7980
- Dispose the gRPC call underlying a Read if the read is only partially consumed [EventStore-Client-Dotnet#234](https://github.com/EventStore/EventStore-Client-Dotnet/pull/234)
8081
- Support `RestartSubsystem()` over gRPC for restarting the persistent subscription subsystem [EventStore-Client-Dotnet#180](https://github.com/EventStore/EventStore-Client-Dotnet/pull/180)
8182
- Remove the exception that logs an error when the subscription is cancelled [EventStore-Client-Dotnet#209](https://github.com/EventStore/EventStore-Client-Dotnet/pull/209)
8283

83-
### Removed
84-
- Drop support for `netcoreapp3.1` [EventStore-Client-Dotnet#204](https://github.com/EventStore/EventStore-Client-Dotnet/pull/204)
85-
8684
## [22.0.0]
8785

86+
### Breaking Changes
87+
- Remove autoAck from Persistent Subscriptions [EventStore-Client-DotNet#175](https://github.com/EventStore/EventStore-Client-Dotnet/pull/175)
88+
- Adjustments to Disposal [EventStore-Client-DotNet#189](https://github.com/EventStore/EventStore-Client-Dotnet/pull/189)
89+
- Rename SoftDeleteAsync to DeleteAsync [EventStore-Client-DotNet#197](https://github.com/EventStore/EventStore-Client-Dotnet/pull/197)
90+
- Standardize gRPC Client Deadlines [EventStore-Client-DotNet#194](https://github.com/EventStore/EventStore-Client-Dotnet/pull/194)
91+
8892
### Fixed
8993
- Get Certifications Path More Reliably [EventStore-Client-DotNet#178](https://github.com/EventStore/EventStore-Client-Dotnet/pull/178)
9094
- Make Client More Backwards Compatibility Friendly [EventStore-Client-DotNet#125](https://github.com/EventStore/EventStore-Client-Dotnet/pull/125)
@@ -93,9 +97,6 @@ All notable changes to this project will be documented in this file.
9397
- Align Persistent Subscription Names [EventStore-Client-DotNet#198](https://github.com/EventStore/EventStore-Client-Dotnet/pull/198)
9498
- Trigger rediscovery when failing to send a message on a streaming call [EventStore-Client-DotNet#222](https://github.com/EventStore/EventStore-Client-Dotnet/pull/222)
9599

96-
### Removed
97-
- Remove autoAck from Persistent Subscriptions [EventStore-Client-DotNet#175](https://github.com/EventStore/EventStore-Client-Dotnet/pull/175)
98-
99100
### Added
100101
- Introduce New Types For Subscription Positions [EventStore-Client-DotNet#188](https://github.com/EventStore/EventStore-Client-Dotnet/pull/188)
101102
- Detect Server Capabilities [EventStore-Client-DotNet#172](https://github.com/EventStore/EventStore-Client-Dotnet/pull/172)
@@ -105,10 +106,7 @@ All notable changes to this project will be documented in this file.
105106
- Implement parameterless IComparable for StreamPosition and StreamRevision [EventStore-Client-DotNet#111](https://github.com/EventStore/EventStore-Client-Dotnet/pull/111)
106107

107108
### Changed
108-
- Adjustments to Disposal [EventStore-Client-DotNet#189](https://github.com/EventStore/EventStore-Client-Dotnet/pull/189)
109109
- send 'requires-leader' header based on NodePreference [EventStore-Client-DotNet#131](https://github.com/EventStore/EventStore-Client-Dotnet/pull/131)
110-
- Rename SoftDeleteAsync to DeleteAsync [EventStore-Client-DotNet#197](https://github.com/EventStore/EventStore-Client-Dotnet/pull/197)
111-
- Standardize gRPC Client Deadlines [EventStore-Client-DotNet#194](https://github.com/EventStore/EventStore-Client-Dotnet/pull/194)
112110

113111
## [21.2.0] - 2021-02-22
114112

@@ -122,16 +120,20 @@ All notable changes to this project will be documented in this file.
122120

123121
## [20.10.0] - 2020-12-09
124122

123+
### Breaking Changes
124+
- Increase gRPC Deadline to Infinite on Persistent Subscriptions [EventStore-Client-DotNet#84](https://github.com/EventStore/EventStore-Client-Dotnet/pull/84)
125+
125126
### Added
126127
- Add Support for Single DNS Gossip Seed [EventStore-Client-DotNet#91](https://github.com/EventStore/EventStore-Client-Dotnet/pull/91)
127128
- Add Connection String Overloads for DI Extensions [EventStore-Client-DotNet#83](https://github.com/EventStore/EventStore-Client-Dotnet/pull/83)
128129
- Add projection reset to client [EventStore-Client-DotNet#79](https://github.com/EventStore/EventStore-Client-Dotnet/pull/79)
129130

130-
### Changed
131-
- Increase gRPC Deadline to Infinite on Persistent Subscriptions [EventStore-Client-DotNet#84](https://github.com/EventStore/EventStore-Client-Dotnet/pull/84)
132-
133131
## [20.6.1] - 2020-09-30
134132

133+
### Breaking Changes
134+
- WrongExpectedVersionResult / WrongExpectedVersionException will use values from server [EventStore-Client-DotNet#73](https://github.com/EventStore/EventStore-Client-Dotnet/pull/73)
135+
- Convert from StreamPosition to StreamRevision; StreamRevision on IWriteResult [EventStore-Client-DotNet#53](https://github.com/EventStore/EventStore-Client-Dotnet/pull/53)
136+
135137
### Added
136138
- Add restarting persistent subscriptions [EventStore-Client-DotNet#68](https://github.com/EventStore/EventStore-Client-Dotnet/pull/68)
137139
- Implement connection string [EventStore-Client-DotNet#49](https://github.com/EventStore/EventStore-Client-Dotnet/pull/49)
@@ -140,20 +142,20 @@ All notable changes to this project will be documented in this file.
140142
- Add ChannelCredentials to EventStoreClientSettings [EventStore-Client-DotNet#46](https://github.com/EventStore/EventStore-Client-Dotnet/pull/46)
141143

142144
### Changed
143-
- WrongExpectedVersionResult / WrongExpectedVersionException will use values from server [EventStore-Client-DotNet#73](https://github.com/EventStore/EventStore-Client-Dotnet/pull/73)
144-
- Convert from StreamPosition to StreamRevision; StreamRevision on IWriteResult [EventStore-Client-DotNet#53](https://github.com/EventStore/EventStore-Client-Dotnet/pull/53)
145145
- Use gRPC Auth Pipeline Instead of Metadata [EventStore-Client-DotNet#52](https://github.com/EventStore/EventStore-Client-Dotnet/pull/52)
146146

147147
## [20.6.0] - 2020-06-09
148148

149+
### Breaking Changes
150+
- Rename HttpEndPointIp to HttpEndPointAddress [EventStore-Client-DotNet#32](https://github.com/EventStore/EventStore-Client-Dotnet/pull/32)
151+
149152
### Added
150153
- Support infinite timeouts [EventStore-Client-DotNet#30](https://github.com/EventStore/EventStore-Client-Dotnet/pull/30)
151154
- Do gossip requests over gRPC [EventStore-Client-DotNet#27](https://github.com/EventStore/EventStore-Client-Dotnet/pull/27)
152155
- Support Bearer Tokens in User Credentials [EventStore-Client-DotNet#24](https://github.com/EventStore/EventStore-Client-Dotnet/pull/24)
153156

154157
### Changed
155158
- Restructured stream name for future planned changes [EventStore-Client-DotNet#33](https://github.com/EventStore/EventStore-Client-Dotnet/pull/33)
156-
- Rename HttpEndPointIp to HttpEndPointAddress [EventStore-Client-DotNet#32](https://github.com/EventStore/EventStore-Client-Dotnet/pull/32)
157159

158160
## [20.6.0-rc] - 2020-06-15
159161

0 commit comments

Comments
 (0)