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.4.20 #875

Merged
merged 1 commit into from
May 24, 2024
Merged

Update CHANGELOG.md for v0.4.20 #875

merged 1 commit into from
May 24, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented May 24, 2024

What this PR does / why we need it:

Update CHANGELOG.md for v0.4.20

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
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Added Resource Configuration to the yorkie-mongodb Helm chart.
    • Introduced a snapshot-disable-gc flag for enhanced control.
  • Improvements

    • Implemented RHT.GC functionality for better performance.
    • Moved the ToXML function from RHT to TreeNode for improved structure.
    • Applied GCPair to TreeNode and TextNode for consistency.
  • Documentation

    • Updated version numbers from v0.4.19 to v0.4.20 in all relevant API documentation files.
  • Chores

    • Updated YORKIE_VERSION in the Makefile to 0.4.20.

Copy link

coderabbitai bot commented May 24, 2024

Walkthrough

In version 0.4.20 of Yorkie, various updates were made, including the implementation of RHT.GC functionality, the addition of resource configuration to the yorkie-mongodb Helm chart, and the introduction of a snapshot-disable-gc flag. Additionally, the ToXML function was moved from RHT to TreeNode, and GCPair was applied to TreeNode and TextNode. Version numbers were updated across several files to reflect the new release.

Changes

Files/Directories Change Summary
CHANGELOG.md Added summary for version 0.4.20 changes.
Makefile Updated YORKIE_VERSION from 0.4.19 to 0.4.20.
api/docs/yorkie.base.yaml Updated version from v0.4.19 to v0.4.20.
api/docs/yorkie/v1/admin.openapi.yaml Updated version from v0.4.19 to v0.4.20.
api/docs/yorkie/v1/resources.openapi.yaml Updated version from v0.4.19 to v0.4.20.
api/docs/yorkie/v1/yorkie.openapi.yaml Updated version from v0.4.19 to v0.4.20.
build/charts/yorkie-cluster/Chart.yaml Updated version and appVersion from 0.4.19 to 0.4.20.

🐇 In Yorkie's code, a new dawn breaks,
Version numbers climb, their journey stakes.
RHT.GC and configs anew,
With TreeNode's XML in view.
From 0.4.19 to 0.4.20, we cheer,
For progress made, let's give a rabbit's ear! 🎉

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 marked this pull request as ready for review May 24, 2024 07:04
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)

Line range hint 289-289: Correct the spelling of "UTF-16" to maintain consistency with the IANA standard.

- Support UTF16 Code Units in yorkie.Tree
+ Support UTF-16 Code Units in yorkie.Tree
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 3540e8b and 93d48d6.
Files selected for processing (7)
  • 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/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 (6)
  • Makefile
  • api/docs/yorkie.base.yaml
  • api/docs/yorkie/v1/admin.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
LanguageTool (1)
CHANGELOG.md (1)

Near line 289: The correct spelling defined by the Internet Assigned Numbers Authority (IANA) is “UTF-16” or “utf-16”.
Context: ...4.1] - 2023-06-09 ### Fixed - Support UTF16 Code Units in yorkie.Tree by @krapie in...

Markdownlint (159)
CHANGELOG.md (159)

14: null
Bare URL used


15: null
Bare URL used


16: null
Bare URL used


20: null
Bare URL used


21: null
Bare URL used


27: null
Bare URL used


28: null
Bare URL used


34: null
Bare URL used


40: null
Bare URL used


44: null
Bare URL used


45: null
Bare URL used


46: null
Bare URL used


50: null
Bare URL used


56: null
Bare URL used


57: null
Bare URL used


58: null
Bare URL used


64: null
Bare URL used


65: null
Bare URL used


66: null
Bare URL used


70: null
Bare URL used


71: null
Bare URL used


72: null
Bare URL used


78: null
Bare URL used


79: null
Bare URL used


80: null
Bare URL used


84: null
Bare URL used


85: null
Bare URL used


91: null
Bare URL used


92: null
Bare URL used


93: null
Bare URL used


97: null
Bare URL used


98: null
Bare URL used


99: null
Bare URL used


105: null
Bare URL used


106: null
Bare URL used


110: null
Bare URL used


111: null
Bare URL used


112: null
Bare URL used


113: null
Bare URL used


119: null
Bare URL used


123: null
Bare URL used


127: null
Bare URL used


133: null
Bare URL used


134: null
Bare URL used


138: null
Bare URL used


139: null
Bare URL used


140: null
Bare URL used


141: null
Bare URL used


142: null
Bare URL used


143: null
Bare URL used


144: null
Bare URL used


145: null
Bare URL used


151: null
Bare URL used


152: null
Bare URL used


153: null
Bare URL used


157: null
Bare URL used


158: null
Bare URL used


164: null
Bare URL used


165: null
Bare URL used


166: null
Bare URL used


167: null
Bare URL used


171: null
Bare URL used


172: null
Bare URL used


178: null
Bare URL used


179: null
Bare URL used


180: null
Bare URL used


184: null
Bare URL used


185: null
Bare URL used


189: null
Bare URL used


193: null
Bare URL used


194: null
Bare URL used


195: null
Bare URL used


196: null
Bare URL used


202: null
Bare URL used


203: null
Bare URL used


204: null
Bare URL used


205: null
Bare URL used


206: null
Bare URL used


207: null
Bare URL used


208: null
Bare URL used


209: null
Bare URL used


210: null
Bare URL used


211: null
Bare URL used


212: null
Bare URL used


216: null
Bare URL used


217: null
Bare URL used


218: null
Bare URL used


219: null
Bare URL used


220: null
Bare URL used


224: null
Bare URL used


225: null
Bare URL used


226: null
Bare URL used


227: null
Bare URL used


228: null
Bare URL used


234: null
Bare URL used


235: null
Bare URL used


239: null
Bare URL used


240: null
Bare URL used


241: null
Bare URL used


245: null
Bare URL used


251: null
Bare URL used


252: null
Bare URL used


256: null
Bare URL used


257: null
Bare URL used


263: null
Bare URL used


264: null
Bare URL used


268: null
Bare URL used


269: null
Bare URL used


270: null
Bare URL used


271: null
Bare URL used


277: null
Bare URL used


278: null
Bare URL used


282: null
Bare URL used


283: null
Bare URL used


289: null
Bare URL used


295: null
Bare URL used


296: null
Bare URL used


300: null
Bare URL used


301: null
Bare URL used


302: null
Bare URL used


308: null
Bare URL used


312: null
Bare URL used


313: null
Bare URL used


314: null
Bare URL used


318: null
Bare URL used


319: null
Bare URL used


320: null
Bare URL used


326: null
Bare URL used


327: null
Bare URL used


328: null
Bare URL used


332: null
Bare URL used


336: null
Bare URL used


337: null
Bare URL used


343: null
Bare URL used


344: null
Bare URL used


345: null
Bare URL used


346: null
Bare URL used


347: null
Bare URL used


351: null
Bare URL used


352: null
Bare URL used


353: null
Bare URL used


361: null
Bare URL used


362: null
Bare URL used


366: null
Bare URL used


367: null
Bare URL used


371: null
Bare URL used


372: null
Bare URL used


378: null
Bare URL used


379: null
Bare URL used


383: null
Bare URL used


384: null
Bare URL used


390: null
Bare URL used


391: null
Bare URL used


392: null
Bare URL used


393: null
Bare URL used


394: null
Bare URL used


398: null
Bare URL used


399: null
Bare URL used


400: null
Bare URL used

Additional comments not posted (2)
CHANGELOG.md (2)

10-22: The changelog entries for version 0.4.20 are well-documented and provide clear links to the respective pull requests. This is crucial for traceability and understanding the context of changes.


10-22: Ensure all new features and changes listed are covered by tests as indicated in the PR checklist.

Copy link

codecov bot commented May 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.56%. Comparing base (3540e8b) to head (93d48d6).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #875   +/-   ##
=======================================
  Coverage   50.56%   50.56%           
=======================================
  Files          70       70           
  Lines       10398    10398           
=======================================
  Hits         5258     5258           
  Misses       4608     4608           
  Partials      532      532           

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

@hackerwins hackerwins merged commit 2d71055 into main May 24, 2024
4 checks passed
@hackerwins hackerwins deleted the v0.4.20 branch May 24, 2024 07:10
@coderabbitai coderabbitai bot mentioned this pull request Oct 28, 2024
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 7, 2024
2 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