Skip to content

Conversation

@Tecvan-fe
Copy link
Collaborator

@Tecvan-fe Tecvan-fe commented Jan 9, 2025

Summary by CodeRabbit

  • New Features

    • Added screen sharing support to the realtime API
    • Introduced browser user agent and template support
    • Enhanced chat workflow capabilities
    • Added image dataset support
  • Bug Fixes

    • Added support for Node.js version 16 with crypto module
    • Improved video device error handling
    • Fixed screen sharing related issues
  • Documentation

    • Added Chinese translations for README files
  • Chores

    • Updated package versions for @coze/api and @coze/realtime-api
    • Updated distribution dependencies

@coderabbitai
Copy link

coderabbitai bot commented Jan 9, 2025

Walkthrough

This pull request involves cleaning up and consolidating changelog and version tracking files for two packages: @coze/api and @coze/realtime-api. Multiple JSON files documenting incremental changes have been removed, and the main changelog files (CHANGELOG.json and CHANGELOG.md) have been updated to version 1.0.16 for @coze/api and 1.0.4 for @coze/realtime-api. The changes include documentation updates, bug fixes, and feature enhancements such as screen sharing support, browser user agent support, and Chinese README translations.

Changes

File Path Change Summary
packages/coze-js/package.json Version updated from 1.0.15-beta.8 to 1.0.16
packages/coze-js/CHANGELOG.json New entry added for version 1.0.16 with patch and minor updates
packages/coze-js/CHANGELOG.md Updated to version 1.0.16 with feature and bug fix details
packages/realtime-api/package.json Version updated from 1.0.3-beta.7 to 1.0.4
packages/realtime-api/CHANGELOG.json New changelog entry added for version 1.0.4
packages/realtime-api/CHANGELOG.md Updated to version 1.0.4 with screen sharing support and bug fixes
common/changes/@coze/* Multiple JSON files documenting incremental changes removed
common/changes/@coze/realtime-api/* Multiple JSON files documenting incremental changes removed

Possibly related PRs

Suggested Reviewers

  • jackshen310
  • jsongo

Poem

🐰 Changelog Cleanup Hop! 🐰

Versions dance, JSON files take flight,
Patches and features, now shining bright
Realtime and API, versions anew
A rabbit's release, clean and true!
Hop, hop, hooray! 🎉

Finishing Touches

  • 📝 Generate Docstrings

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. (Beta)
  • @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.

@Tecvan-fe Tecvan-fe enabled auto-merge January 9, 2025 02:44
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

🧹 Nitpick comments (7)
packages/realtime-api/CHANGELOG.md (2)

12-14: Improve clarity of bug fix descriptions.

The following entries are too vague and should provide more context:

  • "update to dist dep" - What dependencies were updated and why?
  • "setup correct versions" - Which versions were corrected?

14-14: Add details to screen sharing bug fix.

The entry "screen sharing bug" lacks information about what was fixed. Please describe the specific issue that was resolved.

packages/coze-js/CHANGELOG.json (2)

20-20: Fix Node.js spelling.

The official spelling is "Node.js" (with a dot).

-            "comment": "support nodejs 16 version when  using crypto"
+            "comment": "support Node.js 16 version when using crypto"

23-23: Remove redundant version bump entry.

The "bump version" entry is redundant in a changelog as version changes are inherently documented by the changelog entry itself.

packages/coze-js/CHANGELOG.md (3)

14-16: Improve clarity of dependency and version updates.

The following entries should provide more context:

  • "update to dist dep" - Specify which dependencies were updated and why
  • "setup correct versions" - Detail which versions were corrected
🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: The official spelling of this programming framework is “Node.js”.
Context: ... dep - setup correct versions - support nodejs 16 version when using crypto - bump ve...

(NODE_JS)


16-16: Fix Node.js spelling.

The official spelling is "Node.js" (with a dot).

-- support nodejs 16 version when  using crypto
+- support Node.js 16 version when using crypto
🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: The official spelling of this programming framework is “Node.js”.
Context: ... dep - setup correct versions - support nodejs 16 version when using crypto - bump ve...

(NODE_JS)


17-17: Remove redundant version bump entry.

The "bump version" entry is redundant in a changelog as version changes are inherently documented by the changelog entry itself.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e995071 and 72dd7f4.

📒 Files selected for processing (36)
  • common/changes/@coze/api/docs-readme_2025-01-05-03-17.json (0 hunks)
  • common/changes/@coze/api/docs-readme_2025-01-05-04-19.json (0 hunks)
  • common/changes/@coze/api/docs-readme_2025-01-05-04-37.json (0 hunks)
  • common/changes/@coze/api/feat-coze-api_2024-12-24-12-18.json (0 hunks)
  • common/changes/@coze/api/feat-coze-api_2024-12-25-02-45.json (0 hunks)
  • common/changes/@coze/api/feat-datasets_2024-12-17-11-50.json (0 hunks)
  • common/changes/@coze/api/feat-datasets_2024-12-18-06-17.json (0 hunks)
  • common/changes/@coze/api/feat-datasets_2024-12-18-06-50.json (0 hunks)
  • common/changes/@coze/api/feat-datasets_2024-12-30-08-55.json (0 hunks)
  • common/changes/@coze/api/feat-datasets_2024-12-30-09-03.json (0 hunks)
  • common/changes/@coze/api/feat-publish-flow_2024-12-20-06-42.json (0 hunks)
  • common/changes/@coze/api/feat-publish-flow_2024-12-20-07-01.json (0 hunks)
  • common/changes/@coze/api/feat-publish-flow_2024-12-23-07-36.json (0 hunks)
  • common/changes/@coze/api/feat-publish-flow_2024-12-24-02-56.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2024-12-31-14-39.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-01-02-03-11.json (0 hunks)
  • common/changes/@coze/realtime-api/docs-readme_2025-01-05-03-17.json (0 hunks)
  • common/changes/@coze/realtime-api/docs-readme_2025-01-05-04-19.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-publish-flow_2024-12-20-06-42.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-publish-flow_2024-12-20-07-01.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-publish-flow_2024-12-23-07-36.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-publish-flow_2024-12-24-02-56.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-02-11-41.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-02-12-21.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-02-12-49.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-02-13-03.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-07-08-19.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-07-08-27.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-08-06-20.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-08-06-32.json (0 hunks)
  • packages/coze-js/CHANGELOG.json (1 hunks)
  • packages/coze-js/CHANGELOG.md (1 hunks)
  • packages/coze-js/package.json (2 hunks)
  • packages/realtime-api/CHANGELOG.json (1 hunks)
  • packages/realtime-api/CHANGELOG.md (1 hunks)
  • packages/realtime-api/package.json (1 hunks)
💤 Files with no reviewable changes (30)
  • common/changes/@coze/api/docs-readme_2025-01-05-03-17.json
  • common/changes/@coze/api/docs-readme_2025-01-05-04-19.json
  • common/changes/@coze/api/docs-readme_2025-01-05-04-37.json
  • common/changes/@coze/api/feat-publish-flow_2024-12-20-07-01.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-02-11-41.json
  • common/changes/@coze/api/feat-datasets_2024-12-18-06-50.json
  • common/changes/@coze/api/feat-datasets_2024-12-18-06-17.json
  • common/changes/@coze/realtime-api/feat-publish-flow_2024-12-20-06-42.json
  • common/changes/@coze/realtime-api/docs-readme_2025-01-05-04-19.json
  • common/changes/@coze/api/feat-publish-flow_2024-12-20-06-42.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-02-12-21.json
  • common/changes/@coze/realtime-api/feat-publish-flow_2024-12-24-02-56.json
  • common/changes/@coze/api/fix-bug_2024-12-31-14-39.json
  • common/changes/@coze/realtime-api/feat-publish-flow_2024-12-20-07-01.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-02-12-49.json
  • common/changes/@coze/realtime-api/docs-readme_2025-01-05-03-17.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-08-06-20.json
  • common/changes/@coze/api/feat-publish-flow_2024-12-24-02-56.json
  • common/changes/@coze/api/feat-coze-api_2024-12-24-12-18.json
  • common/changes/@coze/api/feat-datasets_2024-12-17-11-50.json
  • common/changes/@coze/api/feat-publish-flow_2024-12-23-07-36.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-08-06-32.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-02-13-03.json
  • common/changes/@coze/api/fix-bug_2025-01-02-03-11.json
  • common/changes/@coze/api/feat-coze-api_2024-12-25-02-45.json
  • common/changes/@coze/api/feat-datasets_2024-12-30-09-03.json
  • common/changes/@coze/api/feat-datasets_2024-12-30-08-55.json
  • common/changes/@coze/realtime-api/feat-publish-flow_2024-12-23-07-36.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-07-08-27.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-01-07-08-19.json
✅ Files skipped from review due to trivial changes (2)
  • packages/coze-js/package.json
  • packages/realtime-api/package.json
🧰 Additional context used
🪛 LanguageTool
packages/coze-js/CHANGELOG.md

[uncategorized] ~16-~16: The official spelling of this programming framework is “Node.js”.
Context: ... dep - setup correct versions - support nodejs 16 version when using crypto - bump ve...

(NODE_JS)

🔇 Additional comments (1)
packages/realtime-api/CHANGELOG.json (1)

1-34: LGTM! Proper structure and categorization.

The JSON structure is valid, and changes are appropriately categorized into patch and minor versions.

@Tecvan-fe Tecvan-fe added this pull request to the merge queue Jan 9, 2025
Merged via the queue into main with commit 692145f Jan 9, 2025
1 check passed
@Tecvan-fe Tecvan-fe deleted the release/20250109-1607f5 branch January 9, 2025 02:46
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.

3 participants