Update CHANGELOG.md for v0.6.22#1408
Conversation
WalkthroughThe changes update version numbers from 0.6.21 to 0.6.22 across multiple files, including changelogs, OpenAPI specifications, a Helm chart, and a Makefile. The changelog also documents new features and refactorings introduced in this release, but no application logic or API schema changes are present. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
api/docs/yorkie/v1/resources.openapi.yaml (1)
6-6: Duplicate – version field correctly updatedSame remark as in
yorkie.base.yaml; value aligns with the release.api/docs/yorkie/v1/cluster.openapi.yaml (1)
6-6: Duplicate – version field correctly updatedMatches the global
v0.6.22bump.
🧹 Nitpick comments (1)
CHANGELOG.md (1)
14-19: Optional: convert bare URLs to Markdown links
markdownlintflags the plain URLs; wrapping them prevents future lint noise.- ... CONTRIBUTING.md for test files by @ggyuchive in https://github.com/yorkie-team/yorkie/pull/1406 + ... CONTRIBUTING.md for test files by @ggyuchive in [#1406](https://github.com/yorkie-team/yorkie/pull/1406)Repeat for other links if you wish to silence MD034.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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)
🧰 Additional context used
🧠 Learnings (7)
api/docs/yorkie/v1/yorkie.openapi.yaml (1)
Learnt from: chacha912
PR: #1164
File: pkg/document/time/version_vector.go:158-183
Timestamp: 2025-02-21T04:54:17.948Z
Learning: In the Yorkie project, the VersionVector.Min and VersionVector.Max methods should maintain consistent behavior and documentation. Both methods should modify the receiver in-place for memory efficiency, take pointer parameters, and document their side effects clearly.
api/docs/yorkie.base.yaml (2)
Learnt from: hackerwins
PR: #1327
File: server/backend/database/mongo/client.go:0-0
Timestamp: 2025-06-17T09:13:52.417Z
Learning: In the Yorkie document database, the updated_at field in document info should only be updated for content operations (when hasOperations == true), not for presence-only changes. This is intentional design behavior to distinguish between actual content modifications and presence updates.
Learnt from: chacha912
PR: #1164
File: pkg/document/time/version_vector.go:158-183
Timestamp: 2025-02-21T04:54:17.948Z
Learning: In the Yorkie project, the VersionVector.Min and VersionVector.Max methods should maintain consistent behavior and documentation. Both methods should modify the receiver in-place for memory efficiency, take pointer parameters, and document their side effects clearly.
build/charts/yorkie-cluster/Chart.yaml (3)
Learnt from: KMSstudio
PR: #1372
File: cmd/yorkie/signup.go:0-0
Timestamp: 2025-07-09T01:45:42.906Z
Learning: In the Yorkie CLI codebase (cmd/yorkie/), global variables like username, password, rpcAddr, and insecure are declared in login.go at package level and are reused across different commands (like signup.go) within the same main package, avoiding unnecessary duplication.
Learnt from: hackerwins
PR: #1036
File: server/clients/clients.go:60-63
Timestamp: 2024-10-17T03:52:24.405Z
Learning: In the Yorkie project, it's acceptable to use insecure connections (e.g., system.WithInsecure(true)) for internal IPC within the cluster, as TLS is not needed in such cases.
Learnt from: KMSstudio
PR: #1372
File: cmd/yorkie/signup.go:0-0
Timestamp: 2025-07-09T01:45:42.906Z
Learning: In the Yorkie CLI codebase, global variables like username, password, rpcAddr, and insecure are declared in login.go at package level and are reused across different commands (like signup.go) within the same main package, avoiding unnecessary duplication.
Makefile (6)
Learnt from: KMSstudio
PR: #1372
File: cmd/yorkie/signup.go:0-0
Timestamp: 2025-07-09T01:45:42.906Z
Learning: In the Yorkie CLI codebase (cmd/yorkie/), global variables like username, password, rpcAddr, and insecure are declared in login.go at package level and are reused across different commands (like signup.go) within the same main package, avoiding unnecessary duplication.
Learnt from: KMSstudio
PR: #1372
File: cmd/yorkie/signup.go:0-0
Timestamp: 2025-07-09T01:45:42.906Z
Learning: In the Yorkie CLI codebase, global variables like username, password, rpcAddr, and insecure are declared in login.go at package level and are reused across different commands (like signup.go) within the same main package, avoiding unnecessary duplication.
Learnt from: hackerwins
PR: #1224
File: test/bench/sync_only_load_bench_test.go:0-0
Timestamp: 2025-04-15T06:38:56.403Z
Learning: In the Yorkie project, benchmark tests that are very resource-intensive (like those creating many clients and connections) should be designed to run only once rather than using the standard Go benchmark iteration pattern with b.N.
Learnt from: hackerwins
PR: #1036
File: server/clients/clients.go:60-63
Timestamp: 2024-10-17T03:52:24.405Z
Learning: In the Yorkie project, it's acceptable to use insecure connections (e.g., system.WithInsecure(true)) for internal IPC within the cluster, as TLS is not needed in such cases.
Learnt from: window9u
PR: #1156
File: server/backend/config.go:235-266
Timestamp: 2025-02-20T00:58:21.388Z
Learning: In Yorkie server, configuration parsing methods (e.g., ParseEventWebhookMaxWaitInterval) use os.Exit(1) for error handling as they are executed during server initialization where early termination on invalid configuration is desired.
Learnt from: chacha912
PR: #1164
File: pkg/document/time/version_vector.go:158-183
Timestamp: 2025-02-21T04:54:17.948Z
Learning: In the Yorkie project, the VersionVector.Min and VersionVector.Max methods should maintain consistent behavior and documentation. Both methods should modify the receiver in-place for memory efficiency, take pointer parameters, and document their side effects clearly.
api/docs/yorkie/v1/resources.openapi.yaml (2)
Learnt from: hackerwins
PR: #1327
File: server/backend/database/mongo/client.go:0-0
Timestamp: 2025-06-17T09:13:52.417Z
Learning: In the Yorkie document database, the updated_at field in document info should only be updated for content operations (when hasOperations == true), not for presence-only changes. This is intentional design behavior to distinguish between actual content modifications and presence updates.
Learnt from: chacha912
PR: #1164
File: pkg/document/time/version_vector.go:158-183
Timestamp: 2025-02-21T04:54:17.948Z
Learning: In the Yorkie project, the VersionVector.Min and VersionVector.Max methods should maintain consistent behavior and documentation. Both methods should modify the receiver in-place for memory efficiency, take pointer parameters, and document their side effects clearly.
api/docs/yorkie/v1/cluster.openapi.yaml (1)
Learnt from: hackerwins
PR: #1327
File: server/backend/database/mongo/client.go:0-0
Timestamp: 2025-06-17T09:13:52.417Z
Learning: In the Yorkie document database, the updated_at field in document info should only be updated for content operations (when hasOperations == true), not for presence-only changes. This is intentional design behavior to distinguish between actual content modifications and presence updates.
CHANGELOG.md (1)
Learnt from: KMSstudio
PR: #1372
File: cmd/yorkie/signup.go:0-0
Timestamp: 2025-07-09T01:45:42.906Z
Learning: In the Yorkie CLI codebase (cmd/yorkie/), global variables like username, password, rpcAddr, and insecure are declared in login.go at package level and are reused across different commands (like signup.go) within the same main package, avoiding unnecessary duplication.
🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md
14-14: Bare URL used
(MD034, no-bare-urls)
18-18: Bare URL used
(MD034, no-bare-urls)
19-19: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (6)
api/docs/yorkie.base.yaml (1)
5-5: All OpenAPI specs updated to v0.6.22Verified that every API spec under
api/docsnow reportsversion: v0.6.22.
Approving these changes.Makefile (1)
1-1: Version variable bumped – LGTM
YORKIE_VERSION := 0.6.22matches the docs update and will be injected viaGO_LDFLAGS. No other build flags affected.api/docs/yorkie/v1/admin.openapi.yaml (1)
6-6: Version bump looks goodThe metadata correctly advances the spec version to
v0.6.22, matching the upcoming release.
No further issues spotted for this change.api/docs/yorkie/v1/yorkie.openapi.yaml (1)
6-6: Version bump looks correct
info.versionupdated tov0.6.22; no other spec changes detected. Consistent with the PR goal.build/charts/yorkie-cluster/Chart.yaml (1)
14-15: Chart and app versions updated coherently
versionandappVersionboth bumped to0.6.22, aligning the Helm chart with the new release.
No further chart-level adjustments required.CHANGELOG.md (1)
10-20: Changelog entry is well-formedNew section for
v0.6.22follows existing style and includes clear “Added / Changed” bullets. ✅
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1408 +/- ##
=======================================
Coverage 37.69% 37.69%
=======================================
Files 182 182
Lines 30381 30381
=======================================
Hits 11453 11453
Misses 18016 18016
Partials 912 912 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
What this PR does / why we need it:
Update CHANGELOG.md for v0.6.22
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