Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Release 2.0.5 #1778

Closed
wants to merge 3 commits into from
Closed

[WIP] Release 2.0.5 #1778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea82338
Remove `release candidate` tag for ably-js React Hooks
VeskeR May 29, 2024
ddab142
chore: bump version for 2.0.5 release
VeskeR May 29, 2024
56c133d
chore: update changelog for 2.0.5 release
VeskeR May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ttypic on a standup you mentioned you would like to move react hooks to the production-ready status in the next minor release. Did you literally mean minor as in ably-js 2.1.0 release, or this 2.0.5 would be fine?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should make it 2.1.0 first of all because of #1762, we introduced new recoveryKeyStorageName option, I think in semantic versioning it should be treated as minor change

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should make it 2.1.0 first of all because of #1762, we introduced new recoveryKeyStorageName option

Oh, true. I remember when I was looking at that PR, I thought the same thing: it would make us bump the minor version in the next release. I didn't go through all the changes for the changelog in this PR, so I initially left it as 2.0.5. But yeah, 2.1.0 will definitely be the version we go with.

Will close this PR and open a 2.1.0 one.


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)
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
3 changes: 0 additions & 3 deletions docs/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/platform/react-hooks/src/AblyReactHooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export type ChannelNameAndOptions = {
export type ChannelNameAndAblyId = Pick<ChannelNameAndOptions, 'channelName' | 'ablyId'>;
export type ChannelParameters = string | ChannelNameAndOptions;

export const version = '2.0.4';
export const version = '2.0.5';

export function channelOptionsWithAgent(options?: Ably.ChannelOptions) {
return {
Expand Down
Loading