Release 2.4.0 #1863
Release 2.4.0 #1863
Conversation
WalkthroughThe pull request introduces version 2.4.0 of the Ably client library, featuring the addition of a new client option Changes
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (3)
README.md (1)
585-585: Documentation looks good, but fix the Markdown formatting issues.The added documentation for the Push plugin provides useful information about the versioning scheme and CDN URLs.
However, please address the following Markdown formatting issues to improve readability:
- Use Markdown link syntax instead of bare URLs. For example, change
https://cdn.ably.com/lib/push.umd.min-2.jsto[https://cdn.ably.com/lib/push.umd.min-2.js](https://cdn.ably.com/lib/push.umd.min-2.js).- Remove the spaces inside the emphasis markers. For example, change
_ versionsto_versions.Apply this diff to fix the formatting issues:
-The Push plugin is developed as part of the Ably client library, so it is available for the same versions as the Ably client library itself. It also means that it follows the same semantic versioning rules as they were defined for [the Ably client library](#for-browsers). For example, to lock into a major or minor version of the Push plugin, you can specify a specific version number such as https://cdn.ably.com/lib/push.umd.min-2.js for all v2._ versions, or https://cdn.ably.com/lib/push.umd.min-2.4.js for all v2.4._ versions, or you can lock into a single release with https://cdn.ably.com/lib/push.umd.min-2.4.0.js. Note you can load the non-minified version by omitting `.min` from the URL such as https://cdn.ably.com/lib/push.umd-2.js. +The Push plugin is developed as part of the Ably client library, so it is available for the same versions as the Ably client library itself. It also means that it follows the same semantic versioning rules as they were defined for [the Ably client library](#for-browsers). For example, to lock into a major or minor version of the Push plugin, you can specify a specific version number such as [https://cdn.ably.com/lib/push.umd.min-2.js](https://cdn.ably.com/lib/push.umd.min-2.js) for all v2._versions, or [https://cdn.ably.com/lib/push.umd.min-2.4.js](https://cdn.ably.com/lib/push.umd.min-2.4.js) for all v2.4._versions, or you can lock into a single release with [https://cdn.ably.com/lib/push.umd.min-2.4.0.js](https://cdn.ably.com/lib/push.umd.min-2.4.0.js). Note you can load the non-minified version by omitting `.min` from the URL such as [https://cdn.ably.com/lib/push.umd-2.js](https://cdn.ably.com/lib/push.umd-2.js).Tools
Markdownlint
585-585: null
Bare URL used(MD034, no-bare-urls)
585-585: null
Bare URL used(MD034, no-bare-urls)
585-585: null
Bare URL used(MD034, no-bare-urls)
585-585: null
Bare URL used(MD034, no-bare-urls)
585-585: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
CHANGELOG.md (2)
7-7: New client option for WebSocket connectivity checks.Adding the
wsConnectivityCheckUrloption is a good enhancement to provide flexibility in connection handling.Please ensure that:
- The option is well-documented, including its purpose, default value, and expected format.
- The library's behavior is verified when the option is not provided or when the connectivity check fails.
8-8: Push plugin now available via CDN.Providing a CDN link for the push plugin is a nice convenience feature for users.
Please ensure that:
- The CDN link is reliable and has high availability.
- The plugin version served by the CDN is always in sync with the library version to avoid compatibility issues.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (4)
- CHANGELOG.md (1 hunks)
- README.md (1 hunks)
- package.json (1 hunks)
- src/platform/react-hooks/src/AblyReactHooks.ts (1 hunks)
Files skipped from review due to trivial changes (2)
- package.json
- src/platform/react-hooks/src/AblyReactHooks.ts
Additional context used
Markdownlint
README.md
585-585: null
Bare URL used(MD034, no-bare-urls)
585-585: null
Bare URL used(MD034, no-bare-urls)
585-585: null
Bare URL used(MD034, no-bare-urls)
585-585: null
Bare URL used(MD034, no-bare-urls)
585-585: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
Summary by CodeRabbit
New Features
wsConnectivityCheckUrlfor enhanced WebSocket connectivity configuration.Updates
2.4.0for the Push plugin, guiding users to the latest resources.2.4.0.