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.5 #1059

Merged
merged 1 commit into from
Nov 7, 2024
Merged

Update CHANGELOG.md for v0.5.5 #1059

merged 1 commit into from
Nov 7, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Nov 7, 2024

What this PR does / why we need it:

Update CHANGELOG.md for v0.5.5

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.5

  • New Features

    • Introduced a dedicated event publisher for each document.
  • Changed

    • Updated the format and handling of the Authorization Webhook Response.
  • Bug Fixes

    • Resolved an issue with version vector validation during migration.
  • Documentation

    • Updated API documentation to reflect the new version (v0.5.5) across multiple specifications.
  • Chores

    • Incremented version numbers in various configuration files to indicate the new release.

Copy link

coderabbitai bot commented Nov 7, 2024

Walkthrough

This pull request introduces version 0.5.5 for the Yorkie project, updating various files to reflect the new version number. The CHANGELOG.md includes new entries for additions, changes, and fixes. The Makefile and multiple OpenAPI specification files have their version numbers updated accordingly. Additionally, the system.openapi.yaml file has been removed. The overall structure and functionality of the project remain unchanged aside from the version updates.

Changes

File Change Summary
CHANGELOG.md Added entry for version 0.5.5, detailing new features, changes, and fixes.
Makefile Updated YORKIE_VERSION from 0.5.4 to 0.5.5; modified GO_LDFLAGS for version injection.
api/docs/yorkie.base.yaml Updated version from v0.5.4 to v0.5.5.
api/docs/yorkie/v1/admin.openapi.yaml Updated version from v0.5.4 to v0.5.5.
api/docs/yorkie/v1/cluster.openapi.yaml Updated version from v0.5.4 to v0.5.5.
api/docs/yorkie/v1/resources.openapi.yaml Updated version from v0.5.4 to v0.5.5.
api/docs/yorkie/v1/yorkie.openapi.yaml Updated version from v0.5.4 to v0.5.5.
api/docs/yorkie/v1/system.openapi.yaml Removed file containing OpenAPI specification for the Yorkie system.
build/charts/yorkie-cluster/Chart.yaml Updated version and appVersion from 0.5.4 to 0.5.5.

Possibly related PRs


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 19c818e and e9558c2.

📒 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 (0 hunks)
  • api/docs/yorkie/v1/yorkie.openapi.yaml (1 hunks)
  • build/charts/yorkie-cluster/Chart.yaml (1 hunks)
💤 Files with no reviewable changes (1)
  • api/docs/yorkie/v1/system.openapi.yaml
✅ Files skipped from review due to trivial changes (6)
  • 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
CHANGELOG.md

14-14: null
Bare URL used

(MD034, no-bare-urls)


18-18: null
Bare URL used

(MD034, no-bare-urls)


22-22: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)
Makefile (2)

1-1: LGTM: Version bump from 0.5.4 to 0.5.5

The version increment follows semantic versioning and is properly propagated through the build process via GO_LDFLAGS.


1-1: Verify version consistency across related files

Let's ensure the version number is consistently updated across all related files mentioned in the AI summary.

✅ Verification successful

Version number is consistently updated across all relevant files

The version 0.5.5 is consistently set across all relevant files:

  • CHANGELOG.md has the correct version entry
  • All OpenAPI spec files in api/docs/ directory have the version set to v0.5.5
  • Helm Chart files in build/charts/yorkie-cluster/Chart.yaml have both version and appVersion set to 0.5.5
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify version consistency across files
# Expected version: 0.5.5

# Check version in CHANGELOG.md
echo "Checking CHANGELOG.md..."
rg "## \[0\.5\.5\]" CHANGELOG.md

# Check version in OpenAPI specs
echo -e "\nChecking OpenAPI specs..."
rg "version: ['\"]?0\.5\.5['\"]?" api/

# Check version in Chart.yaml
echo -e "\nChecking Chart.yaml..."
rg "version: ['\"]?0\.5\.5['\"]?" deploy/helm-charts/yorkie-cluster/Chart.yaml
rg "appVersion: ['\"]?0\.5\.5['\"]?" deploy/helm-charts/yorkie-cluster/Chart.yaml

Length of output: 633


Script:

#!/bin/bash
# Let's check for any Chart.yaml files in the repository
echo "Looking for Chart.yaml files..."
fd "Chart.yaml"

# Let's also check for any other version references in the codebase
echo -e "\nChecking for version references in other files..."
rg "0\.5\.5" --type-not md

# Check package.json and similar files for version
echo -e "\nChecking package files..."
fd "package.json|version.go" --exec cat {}

Length of output: 6289


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 d22c53e into main Nov 7, 2024
5 checks passed
@hackerwins hackerwins deleted the v0.5.5 branch November 7, 2024 09:40
Copy link

codecov bot commented Nov 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.83%. Comparing base (19c818e) to head (e9558c2).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1059   +/-   ##
=======================================
  Coverage   46.83%   46.83%           
=======================================
  Files          84       84           
  Lines       12108    12108           
=======================================
  Hits         5671     5671           
  Misses       5873     5873           
  Partials      564      564           

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

@coderabbitai coderabbitai bot mentioned this pull request Nov 22, 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