From ea82338f98a21a319189b4f312cd00a3b69efd65 Mon Sep 17 00:00:00 2001 From: Andrew Bulat Date: Wed, 29 May 2024 02:59:13 +0100 Subject: [PATCH 1/3] Remove `release candidate` tag for ably-js React Hooks --- README.md | 2 +- docs/react.md | 3 --- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index a139165f2..348cecd06 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ This SDK supports the following platforms: **Node.js:** version 16.x or newer. (1.1.x versions work on Node.js 4.5 or newer, 1.2.x versions work on Node.js 8.17 or newer). We do not currently provide an ESM bundle, please [contact us](https://www.ably.com/contact) if you would would like to use ably-js in a NodeJS ESM project. -**React (release candidate):** We offer a set of React Hooks which make it seamless to use ably-js in your React application. See the [React Hooks documentation](./docs/react.md) for more details. +**React:** We offer a set of React Hooks which make it seamless to use ably-js in your React application. See the [React Hooks documentation](./docs/react.md) for more details. **React Native:** We aim to support all platforms supported by React Native. If you find any issues please raise an issue or [contact us](https://www.ably.com/contact). diff --git a/docs/react.md b/docs/react.md index 68995dbbd..bd0d32afa 100644 --- a/docs/react.md +++ b/docs/react.md @@ -1,8 +1,5 @@ # ably-js React Hooks -> [!IMPORTANT] -> The ably-js React Hooks are currently in the release candidate phase, and there may be breaking changes in a future non-major release. - Use Ably in your React application using idiomatic, easy to use, React Hooks! Using this module you can: From ddab142b52d63e5413e2c30dc2d8d9861d03a744 Mon Sep 17 00:00:00 2001 From: Andrew Bulat Date: Wed, 29 May 2024 02:56:27 +0100 Subject: [PATCH 2/3] chore: bump version for 2.0.5 release --- package-lock.json | 4 ++-- package.json | 2 +- src/platform/react-hooks/src/AblyReactHooks.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index eff3e2839..203fbd229 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "ably", - "version": "2.0.4", + "version": "2.0.5", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "ably", - "version": "2.0.4", + "version": "2.0.5", "license": "Apache-2.0", "dependencies": { "@ably/msgpack-js": "^0.4.0", diff --git a/package.json b/package.json index 8641bf3dc..60bed2aa5 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ably", "description": "Realtime client library for Ably, the realtime messaging service", - "version": "2.0.4", + "version": "2.0.5", "license": "Apache-2.0", "bugs": { "url": "https://github.com/ably/ably-js/issues", diff --git a/src/platform/react-hooks/src/AblyReactHooks.ts b/src/platform/react-hooks/src/AblyReactHooks.ts index ac895b1f4..311a9bdae 100644 --- a/src/platform/react-hooks/src/AblyReactHooks.ts +++ b/src/platform/react-hooks/src/AblyReactHooks.ts @@ -12,7 +12,7 @@ export type ChannelNameAndOptions = { export type ChannelNameAndAblyId = Pick; export type ChannelParameters = string | ChannelNameAndOptions; -export const version = '2.0.4'; +export const version = '2.0.5'; export function channelOptionsWithAgent(options?: Ably.ChannelOptions) { return { From 56c133d0acae5cac57d7f65293c7edb55a88cca4 Mon Sep 17 00:00:00 2001 From: Andrew Bulat Date: Wed, 29 May 2024 02:57:34 +0100 Subject: [PATCH 3/3] chore: update changelog for 2.0.5 release --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 43a7f751a..356555985 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ This contains only the most important and/or user-facing changes; for a full changelog, see the commit history. +## [2.0.5](https://github.com/ably/ably-js/tree/2.0.5) (#TODO REPLACE WITH RELEVANT DATE) + +TODO: WRITE ACTUAL CHANGELOG +- React Hooks are now stable + ## [2.0.4](https://github.com/ably/ably-js/tree/2.0.4) (2024-05-03) - Fix invalid `accessToken` when using REST API Client in React Native [\#1730](https://github.com/ably/ably-js/issues/1730), [\#1749](https://github.com/ably/ably-js/issues/1749)