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

chore: Publish release/20250303-4e87f3 #124

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Tecvan-fe
Copy link
Collaborator

@Tecvan-fe Tecvan-fe commented Mar 3, 2025

Summary by CodeRabbit

  • New Features

    • Enhanced screen sharing with persistent video device support.
    • Improved playback timing, state management, and WebSocket communications for speech and transcription.
    • Introduced asynchronous workflow execution with history tracking.
  • Documentation

    • Updated user documentation and release notes to reflect the new version and features.
  • Chores

    • Upgraded package versions from beta to stable release (v1.1.0).

Copy link

coderabbitai bot commented Mar 3, 2025

Walkthrough

This pull request removes several JSON files that previously documented minor changes in the @coze/api and @coze/realtime-api packages. The removed files covered updates including playback timing, README modifications, unit tests, screen sharing support, WebSocket client additions, and asynchronous workflow execution. Additionally, new version entries have been added in the changelog files and the package version numbers have been updated for both coze-js (from 1.0.21-beta.2 to 1.1.0) and realtime-api (from 1.0.5 to 1.1.0). No alterations were made to exported or public API declarations.

Changes

File(s) Change Summary
common/changes/@coze/api/feat-*.json Deleted JSON files that documented minor changes for @coze/api including playback timing, README updates, unit test additions, screen sharing support, WebSocket client integrations, and asynchronous workflow execution.
common/changes/@coze/realtime-api/feat-*.json Deleted JSON files that recorded minor changes for @coze/realtime-api such as screen sharing support, video device persistence, test code, and unit tests.
packages/coze-js/CHANGELOG.json, CHANGELOG.md, package.json Added a new changelog entry for version 1.1.0 and updated the version from 1.0.21-beta.2 to 1.1.0 for the @coze/api package.
packages/realtime-api/CHANGELOG.json, CHANGELOG.md, package.json Added a new changelog entry for version 1.1.0 and updated the version from 1.0.5 to 1.1.0 for the @coze/realtime-api package.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant WorkflowExecutor
    participant HistoryTracker

    User->>API: Request async workflow execution
    API->>WorkflowExecutor: Initiate workflow
    WorkflowExecutor->>HistoryTracker: Record start
    WorkflowExecutor-->>API: Workflow complete
    API->>HistoryTracker: Log completion
    API-->>User: Send acknowledgment
Loading
sequenceDiagram
    participant User
    participant API
    participant VideoManager

    User->>API: Start screen sharing session
    API->>VideoManager: Activate screen sharing & persist video device
    VideoManager-->>API: Confirm activation
    API-->>User: Screen sharing active
Loading

Possibly related PRs

Suggested reviewers

  • jackshen310

Poem

I'm a rabbit of code, hopping through the day,
Delighting in workflows that smoothly make their way.
With screen sharing activated and tests hopping in time,
Each change is a carrot—sweet, crisp, and sublime.
I nibble on features with a joyful little cheer,
Celebrating every update, my code garden so dear! 🐰


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.
  • @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.

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 (5)
packages/realtime-api/CHANGELOG.md (1)

5-10: New Features List – Consistency Check

The new features listed (screen sharing support, test code, and unit test) effectively communicate the updates. Consider standardizing capitalization (e.g. “add test code” vs. “Add test code”) for improved consistency.

packages/realtime-api/CHANGELOG.json (1)

4-21: New Version JSON Entry Verification

The JSON entry for version “1.1.0” is structured correctly with the proper ISO date and comment details. Please consider reviewing the text casing in the comments to ensure it aligns with your team's conventions (e.g. “add...” vs. “Add...”).

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

5-15: Comprehensive New Features Documentation

The list under “### New Features” is extensive and informative. To enhance clarity, consider standardizing the capitalization and phrasing across bullet points (for example, “Add playback timing and state management” versus “update README.md” versus “Update readme”).


16-19: Bug Fixes Section Query

The “### Bug Fixes” section lists “add unit test.” Since a similar entry appears in the New Features section, please verify if this duplication is intentional or if the categorization needs adjustment.

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

4-41: New Version JSON Entry – Duplication Check

The entry for version “1.1.0” is detailed and correctly structured. However, the comment “add unit test” appears in both the “minor” (line 17) and “patch” (line 37) sections. Please verify whether this duplication is intended or if one instance should be removed or reclassified.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 109446b and 5bd1f6a.

📒 Files selected for processing (23)
  • common/changes/@coze/api/feat-api_2025-02-27-11-10.json (0 hunks)
  • common/changes/@coze/api/feat-api_2025-02-27-12-38.json (0 hunks)
  • common/changes/@coze/api/feat-api_2025-02-28-03-27.json (0 hunks)
  • common/changes/@coze/api/feat-share_screen_2025-02-21-09-29.json (0 hunks)
  • common/changes/@coze/api/feat-share_screen_2025-02-24-06-38.json (0 hunks)
  • common/changes/@coze/api/feat-share_screen_2025-02-27-13-12.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-07-31.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-08-59.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-09-05.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-02-54.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-03-16.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-05-13.json (0 hunks)
  • common/changes/@coze/api/fix-workflow_2025-02-24-12-00.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-21-09-29.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-24-06-38.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-27-12-50.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-27-13-27.json (0 hunks)
  • packages/coze-js/CHANGELOG.json (1 hunks)
  • packages/coze-js/CHANGELOG.md (1 hunks)
  • packages/coze-js/package.json (1 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 (17)
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-07-31.json
  • common/changes/@coze/api/feat-share_screen_2025-02-21-09-29.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-02-54.json
  • common/changes/@coze/api/fix-workflow_2025-02-24-12-00.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-09-05.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-05-13.json
  • common/changes/@coze/api/feat-share_screen_2025-02-27-13-12.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-03-16.json
  • common/changes/@coze/api/feat-share_screen_2025-02-24-06-38.json
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-27-13-27.json
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-21-09-29.json
  • common/changes/@coze/api/feat-api_2025-02-27-11-10.json
  • common/changes/@coze/api/feat-api_2025-02-27-12-38.json
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-27-12-50.json
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-24-06-38.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-08-59.json
  • common/changes/@coze/api/feat-api_2025-02-28-03-27.json
✅ Files skipped from review due to trivial changes (2)
  • packages/realtime-api/package.json
  • packages/coze-js/package.json
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Node.js v20 (ubuntu-latest)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
packages/realtime-api/CHANGELOG.md (1)

3-4: New Version Header Added

The header “## 1.1.0 - 2025-03-03” is clearly formatted and placed at the top of the new version entry.

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

3-4: New Version Header Verification

The header “## 1.1.0 - 2025-03-03” is correctly added and visually aligns with the project’s changelog style.

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