Update CHANGELOG.md for v0.5.3 #1049
Conversation
WalkthroughThe pull request introduces version 0.5.3 for the Yorkie project, updating multiple files to reflect this new version. Key changes include the addition of a new feature, "VersionVector," in the changelog and updates to various OpenAPI specifications and configuration files to align with the new version. The updates primarily involve changing version numbers and standardizing reference formatting across documentation without altering the underlying API functionality. Changes
Possibly related PRs
Suggested labels
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1049 +/- ##
=======================================
Coverage 46.44% 46.44%
=======================================
Files 81 81
Lines 11887 11887
=======================================
Hits 5521 5521
Misses 5806 5806
Partials 560 560 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
CHANGELOG.md (1)
14-14: Consider using reference-style links for URLs.While bare URLs are common in changelogs, consider using reference-style links for better maintainability and readability.
Example format:
-Introduce VersionVector by @JOOHOJANG in https://github.com/yorkie-team/yorkie/pull/1047 +Introduce VersionVector by @JOOHOJANG in [#1047][pr-1047] + +[pr-1047]: https://github.com/yorkie-team/yorkie/pull/1047🧰 Tools
🪛 Markdownlint
14-14: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 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 (4 hunks)
- api/docs/yorkie/v1/cluster.openapi.yaml (1 hunks)
- api/docs/yorkie/v1/resources.openapi.yaml (4 hunks)
- api/docs/yorkie/v1/system.openapi.yaml (1 hunks)
- api/docs/yorkie/v1/yorkie.openapi.yaml (4 hunks)
- build/charts/yorkie-cluster/Chart.yaml (1 hunks)
✅ 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/system.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)
🔇 Additional comments (4)
CHANGELOG.md (1)
10-14: LGTM! The new version entry follows the changelog format.The new version entry is properly formatted and includes all necessary information (version number, date, and changes).
🧰 Tools
🪛 Markdownlint
14-14: null
Bare URL used(MD034, no-bare-urls)
api/docs/yorkie/v1/resources.openapi.yaml (3)
7-7: LGTM: Version update to v0.5.3The version update aligns with the PR objectives and is consistent across the codebase.
223-223: LGTM: Standardized reference formattingThe change to double quotes for
$refentries improves consistency across the OpenAPI specifications.Also applies to: 273-273
1791-1792: LGTM: Well-defined schema for VectorEntry value typesThe schema correctly defines the value field to accept both string and number types, following OpenAPI 3.1.0 specifications for type unions.
| @@ -1,4 +1,4 @@ | |||
| YORKIE_VERSION := 0.5.2 | |||
| YORKIE_VERSION := 0.5.3 | |||
There was a problem hiding this comment.
💡 Codebase verification
Based on the verification results, I can now provide the final response:
Version update needs attention in several components
The version 0.5.3 update is inconsistent across the repository:
- ✅ CHANGELOG.md correctly shows version 0.5.3
- ✅ yorkie-cluster Chart.yaml is updated to version 0.5.3
- ❌ yorkie-argocd Chart.yaml is still at version 0.4.7
- ❌ yorkie-monitoring Chart.yaml is still at version 0.4.11
- ❌ version.go appears to be not updated (current value is "0.0.0")
Please ensure all version references are consistently updated to 0.5.3 across all components, particularly:
- Update version in yorkie-argocd Chart.yaml
- Update version in yorkie-monitoring Chart.yaml
- Update Version variable in version.go
🔗 Analysis chain
LGTM! Version bump looks correct.
The version update from 0.5.2 to 0.5.3 aligns with the PR objectives.
Let's verify version consistency across the repository:
Let me generate additional scripts to verify the version consistency more thoroughly, especially since the Helm charts path seems incorrect.
This broader search will help us:
- Find all version references across the codebase
- Locate the actual path of Helm charts (if they exist)
- Check package files that commonly contain version information
Let's check the actual content of the Chart.yaml files and verify the version in CHANGELOG.md more thoroughly.
This will help us:
- Verify if the Helm charts are properly updated
- Confirm the CHANGELOG.md entry and its content
- Check if version.go files contain the correct version
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that version numbers are consistently updated across all relevant files
# Test 1: Check CHANGELOG.md for the new version
echo "Checking CHANGELOG.md for version 0.5.3..."
rg "## \[0\.5\.3\]" CHANGELOG.md
# Test 2: Check OpenAPI specs
echo -e "\nChecking OpenAPI specs for version 0.5.3..."
rg "version: ['\"](0\.5\.3|v0\.5\.3)" api/docs/
# Test 3: Check Helm charts
echo -e "\nChecking Helm charts for version 0.5.3..."
rg "version: 0\.5\.3" "build/charts/*/Chart.yaml"
rg "appVersion: 0\.5\.3" "build/charts/*/Chart.yaml"
Length of output: 646
Script:
#!/bin/bash
# Let's do a more comprehensive version check
# Check all possible version references in the repository
echo "Checking all files for version 0.5.3 references..."
rg "0\.5\.3" --type-not binary --type-not lock
# Find potential Helm chart locations
echo -e "\nLocating Chart.yaml files..."
fd "Chart.yaml"
# Check package files for version
echo -e "\nChecking package files..."
fd "package.json|version.go" --exec cat {}
Length of output: 5744
Script:
#!/bin/bash
# Check the content of all Chart.yaml files
echo "Checking Chart.yaml contents..."
fd "Chart.yaml" --exec cat {}
# Check CHANGELOG.md for both the version header and content
echo -e "\nChecking CHANGELOG.md content..."
rg -A 5 "## \[0\.5\.3\]" CHANGELOG.md
# Check version.go for any version-related constants or variables
echo -e "\nChecking version.go for version information..."
rg "Version.*=.*\"0\.5\.3\"" internal/version/version.go pkg/version/version.go
Length of output: 3328
What this PR does / why we need it:
Update CHANGELOG.md for v0.5.3
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?:
Additional documentation:
Checklist:
Summary by CodeRabbit
Release Notes for Version 0.5.3
New Features
Documentation Updates
Version Increments