Skip to content

Commit df8c3ee

Browse files
github-actions[bot]github-actions
andauthored
chore(release): v3.0.0 (#105)
Co-authored-by: github-actions <[email protected]>
1 parent 97d5f29 commit df8c3ee

File tree

3 files changed

+18
-1
lines changed

3 files changed

+18
-1
lines changed

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

5+
## [3.0.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.23.0...v3.0.0) (2022-05-24)
6+
7+
8+
### ⚠ BREAKING CHANGES
9+
10+
* **sorbet:** enable runtime typecheck (#104)
11+
12+
> In this release we have enabled runtime level typechecking for Sorbet. This means that if you input parameters
13+
are invalid **your code will throw an error during runtime**. Please ensure that your code is properly tested
14+
before continuing with v3.0.0 of this library.
15+
16+
### Features
17+
18+
* **sorbet:** enable runtime typecheck ([#104](https://github.com/GetStream/stream-chat-ruby/issues/104)) ([97d5f29](https://github.com/GetStream/stream-chat-ruby/commit/97d5f299b652e8328af6e76d0d605c59f05a5cc3))
19+
520
## [2.23.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.22.2...v2.23.0) (2022-05-19)
621

722

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ client = StreamChat::Client.new(api_key='STREAM_KEY', api_secret='STREAM_SECRET'
4747
> 💡 Note: since v2.21.0 we implemented [Sorbet](https://sorbet.org/) type checker. As of v2.x.x we only use it for static type checks and you won't notice any difference, but from v3.0.0 **we will enable runtime checks** 🚨 🚨 🚨.
4848
4949
> What this means, is that you'll receive an error during runtime if you pass an invalid type to our methods. To prepare for that, just make sure whatever you pass in, matches the method signature (`sig { ... }`).
50+
51+
> **Update (2022-May-24)**: we have relased [v3.0.0](https://github.com/GetStream/stream-chat-ruby/releases/tag/v3.0.0) with enabled runtime checks.
5052
5153
---
5254

lib/stream-chat/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
# frozen_string_literal: true
33

44
module StreamChat
5-
VERSION = '2.23.0'
5+
VERSION = '3.0.0'
66
end

0 commit comments

Comments
 (0)