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.3 #916

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Update CHANGELOG.md for v0.5.3 #916

merged 1 commit into from
Oct 23, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Oct 23, 2024

What this PR does / why we need it?

Update CHANGELOG.md for v0.5.3

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 version vector to address garbage collection issues.
  • Chores

    • Updated the changelog to reflect the new version 0.5.3 and its changes.
    • Incremented the version number of the yorkie-js-sdk package from 0.5.2 to 0.5.3.

Copy link

coderabbitai bot commented Oct 23, 2024

Walkthrough

The pull request introduces updates to the CHANGELOG.md and package.json files for the yorkie-js-sdk package. A new version entry for 0.5.3 has been added to the changelog, detailing the introduction of a version vector to address garbage collection issues. Additionally, the version number in package.json has been incremented from 0.5.2 to 0.5.3, with no other changes made to the package metadata or structure.

Changes

File Change Summary
CHANGELOG.md Added new version entry [0.5.3] - 2024-10-23 with description of changes.
packages/sdk/package.json Updated version from 0.5.2 to 0.5.3.

Possibly related PRs

  • Update CHANGELOG.md for v0.5.2 #914: This PR updates the CHANGELOG.md for version 0.5.2, which is directly related to the main PR that introduces version 0.5.3 and documents changes made in the previous version, including updates to the changelog format and versioning.

Poem

Hop, hop, hooray, a new version's here,
With vectors in place, we’ve nothing to fear!
Garbage collection, now handled with grace,
In the changelog, our progress finds its place.
From 0.5.2 to 0.5.3, we leap with delight,
In the world of code, everything feels right! 🐇✨


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.

@hackerwins hackerwins merged commit f292077 into main Oct 23, 2024
2 checks passed
@hackerwins hackerwins deleted the v0.5.3 branch October 23, 2024 07:14
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)

10-14: Wrap the URL in angle brackets for better markdown formatting.

The changelog entry follows the Keep a Changelog format correctly. However, the bare URL should be wrapped in angle brackets for better markdown formatting.

Apply this diff to improve the formatting:

- Introducing version vector to solve GC problem by @JOOHOJANG in https://github.com/yorkie-team/yorkie-js-sdk/pull/899
+ Introducing version vector to solve GC problem by @JOOHOJANG in <https://github.com/yorkie-team/yorkie-js-sdk/pull/899>
🧰 Tools
🪛 Markdownlint

14-14: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2124689 and e6ccf24.

📒 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
CHANGELOG.md

14-14: null
Bare URL used

(MD034, no-bare-urls)

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