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 #1076

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Update CHANGELOG.md for v0.5.6 #1076

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

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

  • Added relevant tests or not required
  • Addressed and resolved all CodeRabbit review comments
  • Didn't break anything

Summary by CodeRabbit

Release Notes for Version 0.5.6

  • New Features

    • Introduced a migration script to detach documents from deactivated clients.
  • Bug Fixes

    • Implemented a minimum Lamport timestamp for garbage collection of deactivated clients.
    • Optimized document detachment in the Cluster Server.
    • Corrected the version vector cleanup process during client deactivation.
    • Fixed the behavior of the ReverseLowerBound function in MemDB.
  • Documentation

    • Updated version numbers across the API documentation and Helm chart to reflect the new version 0.5.6.

Copy link

coderabbitai bot commented Nov 22, 2024

Walkthrough

The pull request introduces several updates primarily focused on version increments across various files to reflect the new version 0.5.6. Key changes include the addition of a migration script for detaching documents from deactivated clients, updates to the garbage collection algorithm, and modifications to the representation of presence changes. Multiple bug fixes are also included, enhancing the functionality and performance of document management and client deactivation processes. The updates are documented in the CHANGELOG.md, and version numbers in OpenAPI specifications and Helm chart files have been updated accordingly.

Changes

File Change Summary
CHANGELOG.md Updated to version 0.5.6; added migration script for document detachment; updated garbage collection algorithm; changed presence representation to binary; multiple bug fixes.
Makefile Incremented YORKIE_VERSION from 0.5.5 to 0.5.6 in GO_LDFLAGS.
api/docs/yorkie.base.yaml Updated version from v0.5.5 to v0.5.6.
api/docs/yorkie/v1/admin.openapi.yaml Updated version from v0.5.5 to v0.5.6.
api/docs/yorkie/v1/cluster.openapi.yaml Updated version from v0.5.5 to v0.5.6.
api/docs/yorkie/v1/resources.openapi.yaml Updated version from v0.5.5 to v0.5.6.
api/docs/yorkie/v1/yorkie.openapi.yaml Updated version from v0.5.5 to v0.5.6.
build/charts/yorkie-cluster/Chart.yaml Updated version and appVersion from 0.5.5 to 0.5.6.

Possibly related PRs

  • Update CHANGELOG.md for v0.5.2 #1045: The changes in this PR include a migration script to detach documents from deactivated clients, which is directly related to the changes made in the main PR regarding client deactivation and document management.
  • Update CHANGELOG.md for v0.5.5 #1059: This PR updates the CHANGELOG.md to reflect changes in version 0.5.5, which includes a fix related to version vector validation during migration, aligning with the main PR's focus on enhancements in document management and client deactivation.

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

codecov bot commented Nov 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.79%. Comparing base (b03f82e) to head (7943a8e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1076   +/-   ##
=======================================
  Coverage   46.79%   46.79%           
=======================================
  Files          84       84           
  Lines       12219    12219           
=======================================
  Hits         5718     5718           
  Misses       5928     5928           
  Partials      573      573           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

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-28: LGTM! The changelog entry follows proper conventions.

The changelog entry for v0.5.6 is well-structured and follows the Keep a Changelog format with proper categorization, PR links, and contributor attributions.

Consider adding brief context about the impact or benefits of these changes. For example:

  • For GC algorithm update: What improvements does it bring?
  • For presence change conversion: What are the benefits of using binary format over string?
    This additional context would help users better understand the significance of these changes.
🧰 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)


19-19: null
Bare URL used

(MD034, no-bare-urls)


23-23: null
Bare URL used

(MD034, no-bare-urls)


24-24: null
Bare URL used

(MD034, no-bare-urls)


25-25: null
Bare URL used

(MD034, no-bare-urls)


26-26: null
Bare URL used

(MD034, no-bare-urls)


27-27: 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 b03f82e and 7943a8e.

📒 Files selected for processing (8)
  • CHANGELOG.md (1 hunks)
  • Makefile (1 hunks)
  • api/docs/yorkie.base.yaml (1 hunks)
  • api/docs/yorkie/v1/admin.openapi.yaml (1 hunks)
  • api/docs/yorkie/v1/cluster.openapi.yaml (1 hunks)
  • api/docs/yorkie/v1/resources.openapi.yaml (1 hunks)
  • api/docs/yorkie/v1/yorkie.openapi.yaml (1 hunks)
  • build/charts/yorkie-cluster/Chart.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (7)
  • Makefile
  • api/docs/yorkie.base.yaml
  • api/docs/yorkie/v1/admin.openapi.yaml
  • api/docs/yorkie/v1/cluster.openapi.yaml
  • api/docs/yorkie/v1/resources.openapi.yaml
  • api/docs/yorkie/v1/yorkie.openapi.yaml
  • build/charts/yorkie-cluster/Chart.yaml
🧰 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)


19-19: null
Bare URL used

(MD034, no-bare-urls)


23-23: null
Bare URL used

(MD034, no-bare-urls)


24-24: null
Bare URL used

(MD034, no-bare-urls)


25-25: null
Bare URL used

(MD034, no-bare-urls)


26-26: null
Bare URL used

(MD034, no-bare-urls)


27-27: null
Bare URL used

(MD034, no-bare-urls)

@hackerwins hackerwins merged commit e863b62 into main Nov 22, 2024
5 checks passed
@hackerwins hackerwins deleted the v0.5.6 branch November 22, 2024 05:46
@coderabbitai coderabbitai bot mentioned this pull request Dec 11, 2024
3 tasks
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