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

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Update CHANGELOG.md for v0.5.7 #1099

merged 1 commit into from
Dec 11, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Dec 11, 2024

What this PR does / why we need it:

Update CHANGELOG.md for v0.5.7

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

  • New Features

    • Introduced new CLI commands and a migration script for version management.
  • Bug Fixes

    • Corrected sharding initialization for dynamic replica set configurations.
    • Ensured preservation of detached client's Lamport in the version vector.
    • Added missing MongoDB sharding configuration for version vectors.
  • Documentation

    • Updated API documentation version from v0.5.6 to v0.5.7 across multiple files.
  • Chores

    • Incremented version numbers in various configuration files to v0.5.7.

Copy link

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes in this pull request include updates to versioning across multiple files for the Yorkie project, reflecting the release of version 0.5.7 dated December 11, 2024. The CHANGELOG.md has been modified to document new features and fixes, including a refactor of the webhook method configuration and updates to version management. Additionally, the Makefile, OpenAPI specifications, and Helm chart have all been updated to reflect the new version number. These updates ensure consistency across the documentation and tooling associated with the Yorkie project.

Changes

File Change Summary
CHANGELOG.md Added new version entry for 0.5.7, detailing changes and fixes related to versioning and document management.
Makefile Updated YORKIE_VERSION from 0.5.6 to 0.5.7.
api/docs/yorkie.base.yaml Updated version from v0.5.6 to v0.5.7.
api/docs/yorkie/v1/admin.openapi.yaml Updated version from v0.5.6 to v0.5.7.
api/docs/yorkie/v1/cluster.openapi.yaml Updated version from v0.5.6 to v0.5.7.
api/docs/yorkie/v1/resources.openapi.yaml Updated version from v0.5.6 to v0.5.7.
api/docs/yorkie/v1/yorkie.openapi.yaml Updated version from v0.5.6 to v0.5.7.
build/charts/yorkie-cluster/Chart.yaml Updated version and appVersion from 0.5.6 to 0.5.7.

Possibly related PRs

  • Update CHANGELOG.md for v0.5.3 #1049: This PR updates the CHANGELOG.md to include a new version entry for 0.5.3, which introduces the VersionVector feature, directly related to the changes in the main PR that also discusses the VersionVector.
  • Update CHANGELOG.md for v0.5.6 #1076: This PR updates the CHANGELOG.md for version 0.5.6, which includes a migration script for detaching documents from deactivated clients, relevant to the document management updates in the main PR.

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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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-24: Format URLs according to markdown standards

The URLs should be properly formatted using markdown link syntax [text](url) instead of bare URLs.

Apply this format to the URLs:

-https://github.com/yorkie-team/yorkie/pull/1082
+[#1082](https://github.com/yorkie-team/yorkie/pull/1082)
🧰 Tools
🪛 Markdownlint (0.35.0)

14-14: null
Bare URL used

(MD034, no-bare-urls)


15-15: null
Bare URL used

(MD034, no-bare-urls)


16-16: null
Bare URL used

(MD034, no-bare-urls)


17-17: null
Bare URL used

(MD034, no-bare-urls)


21-21: null
Bare URL used

(MD034, no-bare-urls)


22-22: 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)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 084cf41 and 25ecbbe.

📒 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)
  • api/docs/yorkie.base.yaml
  • build/charts/yorkie-cluster/Chart.yaml
  • api/docs/yorkie/v1/admin.openapi.yaml
  • api/docs/yorkie/v1/cluster.openapi.yaml
  • Makefile
  • api/docs/yorkie/v1/yorkie.openapi.yaml
  • api/docs/yorkie/v1/resources.openapi.yaml
🧰 Additional context used
🪛 Markdownlint (0.35.0)
CHANGELOG.md

14-14: null
Bare URL used

(MD034, no-bare-urls)


15-15: null
Bare URL used

(MD034, no-bare-urls)


16-16: null
Bare URL used

(MD034, no-bare-urls)


17-17: null
Bare URL used

(MD034, no-bare-urls)


21-21: null
Bare URL used

(MD034, no-bare-urls)


22-22: 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)

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

10-24: LGTM! Well-structured changelog entry

The changelog entry for v0.5.7:

  • Follows the Keep a Changelog format
  • Uses proper semantic versioning
  • Clearly categorizes changes
  • Provides good descriptions with PR references
  • Links changes to contributors
🧰 Tools
🪛 Markdownlint (0.35.0)

14-14: null
Bare URL used

(MD034, no-bare-urls)


15-15: null
Bare URL used

(MD034, no-bare-urls)


16-16: null
Bare URL used

(MD034, no-bare-urls)


17-17: null
Bare URL used

(MD034, no-bare-urls)


21-21: null
Bare URL used

(MD034, no-bare-urls)


22-22: 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)

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.84%. Comparing base (084cf41) to head (25ecbbe).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1099   +/-   ##
=======================================
  Coverage   46.84%   46.84%           
=======================================
  Files          84       84           
  Lines       12256    12256           
=======================================
  Hits         5741     5741           
  Misses       5939     5939           
  Partials      576      576           

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

@hackerwins hackerwins merged commit f35cc77 into main Dec 11, 2024
5 checks passed
@hackerwins hackerwins deleted the v0.5.7 branch December 11, 2024 10:41
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