-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Bump up Yorkie to v0.6.0 #185
Conversation
WalkthroughThis pull request updates version-related configurations for the Yorkie SDK. The environment variables in the Changes
Possibly related PRs
Suggested reviewers
Poem
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.json
is excluded by!**/package-lock.json
📒 Files selected for processing (10)
.env
(1 hunks)docs/auth-webhook.mdx
(1 hunks)examples/nextjs-scheduler/fileInfo.ts
(1 hunks)examples/profile-stack/fileInfo.ts
(1 hunks)examples/react-tldraw/fileInfo.ts
(1 hunks)examples/react-todomvc/fileInfo.ts
(1 hunks)examples/vanilla-codemirror6/fileInfo.ts
(1 hunks)examples/vanilla-quill/fileInfo.ts
(1 hunks)examples/vuejs-kanban/fileInfo.ts
(1 hunks)package.json
(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- examples/react-tldraw/fileInfo.ts
- examples/vanilla-codemirror6/fileInfo.ts
- examples/react-todomvc/fileInfo.ts
- .env
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (5)
package.json (1)
37-37
: Bump dependency version for "yorkie-js-sdk" to v0.6.0The dependency update from
"^0.5.7"
to"^0.6.0"
is correctly applied, ensuring compatibility with the newer minor version. Please double-check the integration tests and any direct usages of this SDK to confirm that no breaking API changes affect the project.docs/auth-webhook.mdx (1)
47-49
: Streamlined Warning Alert ContentThe updated alert now only states, "Configuration changes may take up to 10 minutes to take effect," which simplifies the message by removing the previously confusing bullet points. This offers clearer guidance to users regarding the delay for configuration changes. Just ensure that any critical information removed from the alert is documented elsewhere if needed.
examples/profile-stack/fileInfo.ts (1)
1-2
: Well-organized directory structure with clear separation of concerns!The directory structure effectively separates:
- Public assets (SVG profiles)
- Source code
- Configuration files
examples/vanilla-quill/fileInfo.ts (1)
1-2
: Excellent TypeScript implementation with proper type safety!The directory structure and implementation demonstrate good practices:
- Proper TypeScript configuration
- Clear type definitions
- Well-structured error handling
examples/nextjs-scheduler/fileInfo.ts (1)
1-2
: Excellent Next.js implementation following best practices!The directory structure and implementation demonstrate good practices:
- Proper Next.js app directory structure
- Well-organized React components
- Clean separation of utilities and types
There was a problem hiding this 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
🧹 Nitpick comments (2)
docs/cli.mdx (2)
236-240
: New Flags Description – Clarity & Consistency CheckThe new flags (
--auth-webhook-method-add
and--auth-webhook-method-rm
) and their descriptions are clear. Consider ensuring consistency in terminology (e.g., using "Auth Webhook" uniformly rather than mixing with "authorization-webhook") and clarifying the expected input format for a string array (e.g., whether to pass multiple values using repeated flags or a comma-separated list).
257-260
: Process Order Explanation for Webhook MethodsThe added documentation clarifies that remove operations are processed before add operations, which is helpful for users to understand the behavior. It might be beneficial to briefly mention the rationale behind this ordering (e.g., preventing conflicts or ensuring predictable state changes).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/auth-webhook.mdx
(1 hunks)docs/cli.mdx
(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/auth-webhook.mdx
🔇 Additional comments (1)
docs/cli.mdx (1)
261-281
: Usage Examples – Verifying Multiple Value HandlingThe usage examples for managing webhook methods are comprehensive and easy to follow. Please verify that the CLI tool supports multiple occurrences of the
--auth-webhook-method-add
flag as shown in the multiple flag example. Alternatively, if a comma-separated list is required, consider updating the examples to reflect the correct usage.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution.
What this PR does / why we need it?
Bump up Yorkie to v0.6.0
Any background context you want to provide?
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit
Chores
Documentation