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

Update CHANGELOG.md for v0.5.6 #929

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Update CHANGELOG.md for v0.5.6 #929

merged 1 commit into from
Nov 22, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Nov 22, 2024

What this PR does / why we need it?

Update CHANGELOG.md for v0.5.6

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Introduced a keepalive option in the client.deactivate method to maintain connections during deactivation.
  • Bug Fixes

    • Enhanced garbage collection for nodes linked to deactivated clients to optimize resource management.
  • Chores

    • Updated version number in the package.json file to 0.5.6.

Copy link

coderabbitai bot commented Nov 22, 2024

Walkthrough

The changes in this pull request include the addition of a keepalive option to the client.deactivate method and improvements to the garbage collection process for nodes associated with deactivated clients. These updates are documented in the CHANGELOG.md, which has been revised to reflect the new version 0.5.6. Additionally, the package.json file has been updated to increment the version number from 0.5.5 to 0.5.6.

Changes

File Change Summary
CHANGELOG.md Updated to include version 0.5.6 with new keepalive option in client.deactivate and GC improvements.
packages/sdk/package.json Version updated from 0.5.5 to 0.5.6.

Possibly related PRs

Poem

🐇 In the meadow where rabbits play,
A new option brightens the day.
With keepalive, connections stay,
While GC tidies without delay.
Hops of joy, let’s cheer and say,
"Version 0.5.6, hip-hip-hooray!" 🌼


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 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.

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

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

14-14: Wrap bare URLs in angle brackets for better markdown formatting.

The bare URLs should be wrapped in angle brackets according to markdown best practices.

-by @JOOHOJANG in https://github.com/yorkie-team/yorkie-js-sdk/pull/928
+by @JOOHOJANG in <https://github.com/yorkie-team/yorkie-js-sdk/pull/928>

-by @JOOHOJANG in https://github.com/yorkie-team/yorkie-js-sdk/pull/926
+by @JOOHOJANG in <https://github.com/yorkie-team/yorkie-js-sdk/pull/926>

Also applies to: 18-18

🧰 Tools
🪛 Markdownlint (0.35.0)

14-14: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bc21a84 and da84edc.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • packages/sdk/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/sdk/package.json
🧰 Additional context used
🪛 Markdownlint (0.35.0)
CHANGELOG.md

14-14: null
Bare URL used

(MD034, no-bare-urls)


18-18: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)
CHANGELOG.md (1)

10-19: LGTM! The changelog entry is well-structured and complete.

The changelog entry:

  • Follows the Keep a Changelog format
  • Includes correct version and date
  • Properly categorizes changes under "Added" and "Fixed" sections
  • Accurately documents the keepalive option addition and GC improvements
  • Properly attributes changes to contributors
🧰 Tools
🪛 Markdownlint (0.35.0)

14-14: null
Bare URL used

(MD034, no-bare-urls)


18-18: null
Bare URL used

(MD034, no-bare-urls)

@hackerwins hackerwins merged commit 63d2dce into main Nov 22, 2024
2 checks passed
@hackerwins hackerwins deleted the v0.5.6 branch November 22, 2024 06:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant