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.

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

CHORE: Add release information for v.2.7.0 #1943

Closed
wants to merge 1 commit into from
Closed

Conversation

splindsay-92
Copy link
Contributor

@splindsay-92 splindsay-92 commented Jan 13, 2025

  • Update CHANGELOG
  • Update Ably package version

Summary by CodeRabbit

  • Version Update
    • Released version 2.7.0 of the library
  • Enum Changes
    • Removed ATTACH_RESUME channel mode
    • Deprecated UNSET, ANNOTATION_CREATE, and ANNOTATION_DELETE message actions
    • Added new MESSAGE_SUMMARY message action type
  • Improvements
    • Enhanced type definitions and message handling

- Update CHANGELOG
- Update Ably package version
Copy link

coderabbitai bot commented Jan 13, 2025

Walkthrough

This pull request introduces version 2.7.0 with several modifications to the Ably realtime client library. The changes primarily involve updates to enum definitions in the CHANGELOG.md, specifically removing the ATTACH_RESUME channel mode and deprecating certain message actions. The package version has been consistently updated across package.json and the React hooks module to reflect these changes.

Changes

File Change Summary
CHANGELOG.md - Removed ATTACH_RESUME from ChannelModes
- Deprecated UNSET, ANNOTATION_CREATE, and ANNOTATION_DELETE from MESSAGE_ACTIONS
- Added new MESSAGE_SUMMARY action
package.json Updated version from 2.6.0 to 2.7.0
src/platform/react-hooks/src/AblyReactHooks.ts Updated version constant from '2.6.0' to '2.7.0'

Poem

🐰 A version hop, a bunny's delight,
Enums refined with technical might,
MESSAGE_SUMMARY now takes the stage,
Deprecated actions turn a new page,
Version 2.7.0 hops into sight! 🚀


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

## [2.7.0](https://github.com/ably/ably-js/tree/2.7.0) (2025-01-13)

- 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Deprecates, or removes?

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
CHANGELOG.md (1)

5-11: LGTM! Consider adding migration notes for deprecated features.

The changelog entries are clear and well-structured. However, since multiple features are being deprecated, it would be helpful to add migration notes or links to documentation explaining the recommended alternatives for:

  • Using message actions now that UNSET is deprecated
  • Handling annotations after ANNOTATION_CREATE and ANNOTATION_DELETE are deprecated
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 494500f and df9e5d4.

⛔ Files ignored due to path filters (1)
  • package-lock.json is 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 due to trivial changes (2)
  • package.json
  • src/platform/react-hooks/src/AblyReactHooks.ts
⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: test-browser (webkit)
  • GitHub Check: test-node (20.x)
  • GitHub Check: test-browser (firefox)
  • GitHub Check: test-node (18.x)
  • GitHub Check: test-browser (chromium)
  • GitHub Check: test-node (16.x)
  • GitHub Check: test-npm-package
  • 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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants