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 2.6.0 #1936

Merged
merged 2 commits into from
Dec 10, 2024
Merged

chore: add release information for 2.6.0 #1936

merged 2 commits into from
Dec 10, 2024

Conversation

AndyTWF
Copy link
Contributor

@AndyTWF AndyTWF commented Dec 9, 2024

This change adds the README and other updates for 2.6.0.

Summary by CodeRabbit

  • New Features

    • Updated presence functionality to emit a LEAVE event only if a member was previously present.
    • Introduced experimental attributes on the Message type for edits and deletes.
  • Bug Fixes

    • Removed a build check allowing npm to reference specific branches in the ably-js repository.
  • Version Updates

    • Incremented version number from 2.5.0 to 2.6.0 across relevant files.

@AndyTWF AndyTWF requested review from VeskeR and ttypic December 9, 2024 14:57
Copy link

coderabbitai bot commented Dec 9, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request include updates to the versioning of the package and related files. The CHANGELOG.md has been modified to reflect the new version 2.6.0 and document key changes, including the removal of a build check and modifications to presence functionality. The package.json file has been updated to the new version number, and the version constant in AblyReactHooks.ts has also been updated to align with this version increment.

Changes

File Change Summary
CHANGELOG.md Added version entry for 2.6.0, documenting the removal of a build check, presence functionality changes, and updates to Message type attributes.
package.json Updated version from 2.5.0 to 2.6.0.
src/platform/react-hooks/src/AblyReactHooks.ts Updated exported constant version from '2.5.0' to '2.6.0', affecting the agent parameter in channelOptionsWithAgent.

Possibly related PRs

  • Release version 2.5.0 #1915: The changes in this PR involve updating the version in CHANGELOG.md, package.json, and src/platform/react-hooks/src/AblyReactHooks.ts to 2.5.0, which is directly related to the version update to 2.6.0 in the main PR.

Suggested reviewers

  • VeskeR
  • SimonWoolf
  • ttypic

🐇 In the code, we hop with glee,
A new version, oh so free!
Changes made, updates bright,
In the logs, our joy takes flight!
With each line, we dance and play,
Celebrating code in a joyful way!
🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8a3552d and 97eb58f.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)

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. (Experiment)
  • @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.

@github-actions github-actions bot temporarily deployed to staging/pull/1936/bundle-report December 9, 2024 14:58 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1936/typedoc December 9, 2024 14:58 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1936/features December 9, 2024 14:58 Inactive
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: 2

🧹 Outside diff range and nitpick comments (1)
CHANGELOG.md (1)

9-9: Document experimental features

The experimental attributes for Message type supporting edits and deletes should be clearly documented with:

  1. A warning that these are experimental features subject to change
  2. Examples of usage
  3. Any limitations or known issues
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 174953b and db140f9.

⛔ 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)
  • src/platform/react-hooks/src/AblyReactHooks.ts
  • package.json

CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ttypic ttypic left a comment

Choose a reason for hiding this comment

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

LGTM

@github-actions github-actions bot temporarily deployed to staging/pull/1936/bundle-report December 9, 2024 16:56 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1936/features December 9, 2024 16:56 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1936/typedoc December 9, 2024 16:56 Inactive
Copy link
Contributor

@VeskeR VeskeR left a comment

Choose a reason for hiding this comment

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

LGTM. Update the date and can merge

CHANGELOG.md Outdated Show resolved Hide resolved
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.

3 participants