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.4 #1054

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Update CHANGELOG.md for v0.5.4 #1054

merged 1 commit into from
Oct 28, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Oct 28, 2024

What this PR does / why we need it:

Update CHANGELOG.md for v0.5.4

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

Release Notes for Version 0.5.4

  • New Features

    • Introduced a cmap for distributing mutexes per document.
    • Implemented lock striping for cmap.
  • Bug Fixes

    • Corrected the transaction in UpdateAndFindMinSyncedVersionVector.
  • Documentation Updates

    • Updated version numbers across various API documentation files to reflect the new version (v0.5.4).
  • Version Updates

    • Updated project version from 0.5.3 to 0.5.4 in multiple components, including the Makefile and Chart.yaml.

Copy link

coderabbitai bot commented Oct 28, 2024

Walkthrough

This pull request includes updates to multiple files to reflect the new version 0.5.4 for the Yorkie project. Changes are made to the CHANGELOG.md to document new features and fixes, as well as updates to various OpenAPI specification files and the Makefile to indicate the new version. Additionally, the Chart.yaml for the yorkie-cluster application has been updated to match the new version. No functional changes were made to the code or API endpoints.

Changes

File Change Summary
CHANGELOG.md Updated to version 0.5.4, added features for cmap mutex distribution and lock striping, and fixed a transaction issue.
Makefile Updated YORKIE_VERSION from 0.5.3 to 0.5.4.
api/docs/yorkie.base.yaml Updated version from v0.5.3 to v0.5.4.
api/docs/yorkie/v1/admin.openapi.yaml Updated version from v0.5.3 to v0.5.4.
api/docs/yorkie/v1/cluster.openapi.yaml Updated version from v0.5.3 to v0.5.4.
api/docs/yorkie/v1/resources.openapi.yaml Updated version from v0.5.3 to v0.5.4.
api/docs/yorkie/v1/system.openapi.yaml Updated version from v0.5.3 to v0.5.4.
api/docs/yorkie/v1/yorkie.openapi.yaml Updated version from v0.5.3 to v0.5.4.
build/charts/yorkie-cluster/Chart.yaml Updated version and appVersion from 0.5.3 to 0.5.4.

Possibly related PRs


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c776ae1 and 3348a50.

📒 Files selected for processing (9)
  • 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/system.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 (8)
  • 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/system.openapi.yaml
  • api/docs/yorkie/v1/yorkie.openapi.yaml
  • build/charts/yorkie-cluster/Chart.yaml
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[uncategorized] ~14-~14: Did you mean “document”? If following ‘per’, nouns are often singular.
Context: ...oduce cmap for distributing mutexes per documents by @hackerwins in https://github.com/yo...

(CONFUSION_OF_NNS_NN_UN)

🪛 Markdownlint
CHANGELOG.md

14-14: null
Bare URL used

(MD034, no-bare-urls)


15-15: null
Bare URL used

(MD034, no-bare-urls)


19-19: null
Bare URL used

(MD034, no-bare-urls)


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 37548c0 into main Oct 28, 2024
5 checks passed
@hackerwins hackerwins deleted the v0.5.4 branch October 28, 2024 01:17
Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.76%. Comparing base (c776ae1) to head (3348a50).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1054   +/-   ##
=======================================
  Coverage   46.76%   46.76%           
=======================================
  Files          82       82           
  Lines       12001    12001           
=======================================
  Hits         5612     5612           
  Misses       5826     5826           
  Partials      563      563           

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

hackerwins added a commit that referenced this pull request Oct 28, 2024
@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