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: 0.3.0 release #431

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

chore: 0.3.0 release #431

wants to merge 4 commits into from

Conversation

AndyTWF
Copy link
Collaborator

@AndyTWF AndyTWF commented Dec 9, 2024

Context

CHA-751

Description

This change:

  • Updates the package version around the codebase
  • Updates the CHANGELOG
  • Updates the upcoming feature list in the README
  • Adds UPGRADING.md to provide more guidance for upgrading
  • Returns ably-js to tagged versions again, with the release of 2.6.0

Checklist

  • QA'd by the author.
  • Unit tests created (if applicable).
  • Integration tests created (if applicable).
  • Follow coding style guidelines found here.
  • TypeDoc updated (if applicable).
  • (Optional) Update documentation for new features.
  • Browser tests created (if applicable).
  • In repo demo app updated (if applicable).

Testing Instructions (Optional)

N/A

@AndyTWF AndyTWF requested review from a team, vladvelici and splindsay-92 and removed request for a team December 9, 2024 15:57
Copy link

coderabbitai bot commented Dec 9, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

@AndyTWF AndyTWF requested review from owenpearson and removed request for vladvelici December 9, 2024 15:57
@AndyTWF
Copy link
Collaborator Author

AndyTWF commented Dec 9, 2024

@owenpearson @splindsay-92 This is ready for a review. I need to bump the ably-js version in package.json, so will do that shortly before merging once ably-js has landed.

@github-actions github-actions bot temporarily deployed to staging/pull/431/typedoc December 9, 2024 15:58 Inactive
Copy link

github-actions bot commented Dec 9, 2024

Coverage Report

Status Category Percentage Covered / Total
🟢 Lines 93.93% (🎯 92%) 3316 / 3530
🟢 Statements 93.93% (🎯 92%) 3316 / 3530
🟢 Functions 96.15% (🎯 92%) 250 / 260
🟢 Branches 94.45% (🎯 93%) 852 / 902
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
src/core/chat-api.ts 100% 90.9% 100% 100%
src/core/headers.ts 0% 0% 0% 0% 1
src/core/id.ts 100% 100% 100% 100%
src/core/message.ts 100% 100% 100% 100%
src/core/messages.ts 92.85% 92.15% 100% 92.85% 426-428, 458-462, 474-478, 593-595, 628-630
src/core/metadata.ts 0% 0% 0% 0% 1
src/core/version.ts 100% 100% 100% 100%
src/react/helper/room-promise.ts 97.72% 100% 100% 97.72% 66
src/react/hooks/use-messages.ts 96.11% 92.59% 100% 96.11% 145-146, 153-154
Generated in workflow #1878 for commit 26fa7a9 by the Vitest Coverage Report Action

@github-actions github-actions bot temporarily deployed to staging/pull/431/typedoc December 9, 2024 16:03 Inactive
@AndyTWF AndyTWF marked this pull request as ready for review December 10, 2024 09:43
@github-actions github-actions bot temporarily deployed to staging/pull/431/typedoc December 10, 2024 09:44 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/431/typedoc December 10, 2024 10:39 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/431/typedoc December 11, 2024 13:24 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/431/typedoc December 16, 2024 17:43 Inactive
AndyTWF and others added 4 commits December 16, 2024 17:44
This change:

- Updates the package version around the codebase
- Updates the CHANGELOG
- Updates the upcoming feature list in the README
- Adds UPGRADING.md to provide more guidance for upgrading
- Add some missing changes from action*() to version*()
- Generally update wording for clarity
Fixed a few typos across multiple files.
Corrected the typedocs for getPreviousMessages in the use-messages.ts file, they now correctly state the direction of fetched messages is newest to oldest.
The type was exported but not used anywhere.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants