CHORE: Add release information for v.3.0.0 #1942
Conversation
WalkthroughThe pull request introduces version 2.7.0 of the Changes
Poem
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 (
|
splindsay-92
requested review from
AndyTWF,
VeskeR and
ttypic
and removed request for
AndyTWF
github-actions
bot
temporarily deployed
to
staging/pull/1942/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1942/features
github-actions
bot
temporarily deployed
to
staging/pull/1942/typedoc
CHANGELOG.md
Outdated
| @@ -2,6 +2,14 @@ | |||
|
|
|||
| This contains only the most important and/or user-facing changes; for a full changelog, see the commit history. | |||
|
|
|||
| ## [3.0.0](https://github.com/ably/ably-js/tree/3.0.0) (2025-01-13) | |||
There was a problem hiding this comment.
If we're going for 3.0.0 just because of the changes to the MESSAGE_ACTIONS enum, I think we can probably just do this as a minor change. It's only used internally by Chat right now and is not documented for use elsewhere.
There was a problem hiding this comment.
@SimonWoolf Mentioned breaking changes in his commits, hence the 3.0.0 label. Looks like a change to the channel modes enum too.
There was a problem hiding this comment.
No no, this doesn't need to be a new major ably-js version. Nothing is using MESSAGE_ACTIONS except the just-released chat alpha
There was a problem hiding this comment.
and to the extent it is a breaking change it's a breaking change in the wire protocol, not the public API. The public API for actions is the string, which isn't changing
There was a problem hiding this comment.
Correcting this and making a mental note to ignore coderabbits PR changelog
- Update CHANGELOG - Update Ably package version
splindsay-92
force-pushed
the
release/3.0.0
branch
from
808e470 to
df9e5d4
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (3)
CHANGELOG.md(1 hunks)package.json(1 hunks)src/platform/react-hooks/src/AblyReactHooks.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- package.json
- src/platform/react-hooks/src/AblyReactHooks.ts
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: test-node (20.x)
- GitHub Check: test-node (18.x)
- GitHub Check: test-browser (webkit)
- GitHub Check: test-browser (firefox)
- GitHub Check: test-node (16.x)
- GitHub Check: test-browser (chromium)
- GitHub Check: test-npm-package
🔇 Additional comments (1)
CHANGELOG.md (1)
5-11: Version number inconsistency with PR titleThe PR title indicates this is for v3.0.0, but the changelog entry is for v2.7.0. Based on the past review comments, this was discussed and determined that a major version bump is not needed as the MESSAGE_ACTIONS changes are only used internally by Chat.
However, the removal of
ATTACH_RESUMEfrom theChannelModesenum could be a breaking change if it's part of the public API. Please verify if this warrants a major version bump.Run the following script to check if
ATTACH_RESUMEis part of the public API:✅ Verification successful
Version number is correct, no major bump needed
The removal of
ATTACH_RESUMEfromChannelModesenum is not a breaking change as it's an internal implementation detail used as a protocol flag, not exposed in the public API. The v2.7.0 version is appropriate for this change.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check if ATTACH_RESUME is used in the codebase or documented as public API # Search for ATTACH_RESUME usage in code echo "Searching for ATTACH_RESUME usage in code..." rg -l "ATTACH_RESUME" # Search for ATTACH_RESUME in documentation echo "Searching for ATTACH_RESUME in documentation..." fd -e md -e rst -e txt | xargs rg "ATTACH_RESUME"Length of output: 499
Script:
#!/bin/bash # Check if ChannelModes is exported and examine its usage echo "Checking ChannelModes exports..." rg "export.*ChannelModes" -A 5 echo -e "\nChecking ATTACH_RESUME implementation..." ast-grep --pattern 'enum ChannelModes { $$$ }' echo -e "\nChecking ATTACH_RESUME usage in RealtimeChannel..." rg "ATTACH_RESUME" src/common/lib/client/realtimechannel.ts -A 3 echo -e "\nChecking test implementation..." rg "ATTACH_RESUME" test/realtime/resume.test.js -A 3Length of output: 962
| - Removed an incorrect channel mode `ATTACH_RESUME` from the `ChannelModes` enum. | ||
| - Deprecates the `UNSET` type from `MESSAGE_ACTIONS` enum, all messages will always have their `action` set. | ||
| - Deprecates `ANNOTATION_CREATE` and `ANNOTATION_DELETE` from the `MESSAGE_ACTIONS` enum. | ||
| - Adds support for upcoming message summaries with the new `MESSAGE_SUMMARY` message action type. | ||
| - Multiple improvements to type definitions and message handling. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add migration notes for breaking changes
Since there are breaking changes (removal of ATTACH_RESUME and deprecation of message action types), it would be helpful to add migration notes for users. Consider adding:
- Impact of removing
ATTACH_RESUME - Migration path for deprecated message action types
- How to adopt the new
MESSAGE_SUMMARYaction type
| @@ -2,6 +2,14 @@ | |||
|
|
|||
| This contains only the most important and/or user-facing changes; for a full changelog, see the commit history. | |||
|
|
|||
| ## [2.7.0](https://github.com/ably/ably-js/tree/2.7.0) (2025-01-13) | |||
There was a problem hiding this comment.
Invalid future date
The release date is set to 2025-01-13, which is in the future. Please update this to the actual release date.
-## [2.7.0](https://github.com/ably/ably-js/tree/2.7.0) (2025-01-13)
+## [2.7.0](https://github.com/ably/ably-js/tree/2.7.0) (2024-01-13)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## [2.7.0](https://github.com/ably/ably-js/tree/2.7.0) (2025-01-13) | |
| ## [2.7.0](https://github.com/ably/ably-js/tree/2.7.0) (2024-01-13) |
Summary by CodeRabbit
Release Notes for Version 2.7.0
Breaking Changes
ATTACH_RESUMEchannel modeUNSET,ANNOTATION_CREATE, andANNOTATION_DELETEmessage actionsNew Features
MESSAGE_SUMMARYmessage action type to support new messaging capabilitiesVersion Update
This release introduces significant changes to message handling and channel modes, focusing on improving clarity and expanding messaging functionality.