Skip to content

Release version 0.3.0#269

Merged
lawrence-forooghian merged 1 commit intomainfrom
release/0.3.0
Apr 14, 2025
Merged

Release version 0.3.0#269
lawrence-forooghian merged 1 commit intomainfrom
release/0.3.0

Conversation

@lawrence-forooghian
Copy link
Copy Markdown
Collaborator

@lawrence-forooghian lawrence-forooghian commented Apr 14, 2025

This was originally intended as a "fix compiler crash in Xcode 16.3" release, but actually it turns out 0.2.0 compiles fine in Xcode 16.3 (since we hadn't yet introduced typed throws). So instead it's now a "@MainActor and typed throws" release.

Documentation changes are in ably/docs#2532.

Summary by CodeRabbit

  • New Features

    • Updated the SDK to version 0.3.0, enhancing overall protocol responsiveness and error clarity.
  • Documentation

    • Improved the release notes with detailed changelog entries and a link to a full version comparison for additional context.

This was originally intended as a "fix compiler crash in Xcode 16.3"
release, but actually it turns out 0.2.0 compiles fine in Xcode 16.3
(since we hadn't yet introduced typed throws). So instead it's now a
"@mainactor and typed throws" release.

Documentation changes are in ably/docs#2532.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 14, 2025

Walkthrough

This update bumps the SDK version to 0.3.0. The CHANGELOG now includes a version entry with details about two changes: main protocols are annotated with @MainActor and all thrown errors are explicitly typed as ARTErrorInfo. A link comparing versions 0.2.0 and 0.3.0 is also added. Additionally, the version constant in Version.swift has been updated accordingly.

Changes

File(s) Change Summary
CHANGELOG.md Added new version entry for 0.3.0; introduced a "What's Changed" section listing the @MainActor annotation for protocols, error type update, and a full changelog link.
Sources/AblyChat/Version.swift Updated the internal version constant from "0.2.0" to "0.3.0", reflecting the new SDK version.

Possibly related PRs

Suggested reviewers

  • umair-ably
  • maratal

Poem

I'm a rabbit, hopping on code trails so bright,
Celebrating changes from day to night.
Version bumped to 0.3.0 with care,
New annotations and error types everywhere.
With joyful hops and a nibble or two,
I cheer for the update—hip, hip, woo!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ 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 plan to trigger planning for file edits and PR creation.
  • @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
Copy Markdown

@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 (3)
Sources/AblyChat/Version.swift (1)

1-10: Reminder on TODO comment.
There is a TODO on line 3 regarding the chat-js implementation for sending up agent info. While this change isn’t directly related to the version bump, please ensure that this temporary copy is tracked for future refactoring or proper integration.

CHANGELOG.md (2)

7-8: Stylistic suggestion for conciseness.
The list items currently read:

  • "All of the main protocols in the SDK are now marked as @MainActor, to simplify the experience of using the SDK. (#261)"
  • "All of the errors thrown by the SDK are now explicitly typed as ARTErrorInfo. (#234)"

Consider removing the redundant “of” to make the wording a bit more concise. For example:

  • "Main protocols in the SDK are now marked as @MainActor to simplify usage. (#261)"
  • "Errors thrown by the SDK are now explicitly typed as ARTErrorInfo. (#234)"
🧰 Tools
🪛 LanguageTool

[style] ~7-~7: Consider removing “of” to be more concise
Context: ...swift/tree/0.3.0) ## What's Changed - All of the main protocols in the SDK are now marke...

(ALL_OF_THE)


[style] ~8-~8: Consider removing “of” to be more concise
Context: ...e experience of using the SDK. (#261) - All of the errors thrown by the SDK are now explic...

(ALL_OF_THE)


10-10: Markdown formatting improvement.
The bare URL in the changelog entry can trigger markdown lint warnings. Consider formatting it as a markdown link. For example, change:

-**Full Changelog**: https://github.com/ably/ably-chat-swift/compare/0.2.0...0.3.0
+**Full Changelog**: [Full Changelog](https://github.com/ably/ably-chat-swift/compare/0.2.0...0.3.0)

This will improve readability and adhere to markdown best practices.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

10-10: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 43181a8 and 0c6d65d.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • Sources/AblyChat/Version.swift (1 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[style] ~7-~7: Consider removing “of” to be more concise
Context: ...swift/tree/0.3.0) ## What's Changed - All of the main protocols in the SDK are now marke...

(ALL_OF_THE)


[style] ~8-~8: Consider removing “of” to be more concise
Context: ...e experience of using the SDK. (#261) - All of the errors thrown by the SDK are now explic...

(ALL_OF_THE)

🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md

10-10: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: Example app, tvOS (Xcode 16.3)
  • GitHub Check: Example app, tvOS (Xcode 16.2)
  • GitHub Check: Example app, iOS (Xcode 16.3)
  • GitHub Check: Xcode, tvOS (Xcode 16.3)
  • GitHub Check: Xcode, release configuration, tvOS (Xcode 16.3)
  • GitHub Check: Example app, iOS (Xcode 16.2)
  • GitHub Check: Xcode, tvOS (Xcode 16.2)
  • GitHub Check: Example app, macOS (Xcode 16.3)
  • GitHub Check: Xcode, release configuration, tvOS (Xcode 16.2)
  • GitHub Check: Xcode, iOS (Xcode 16.3)
  • GitHub Check: Xcode, release configuration, iOS (Xcode 16.3)
  • GitHub Check: Xcode, iOS (Xcode 16.2)
  • GitHub Check: Xcode, release configuration, iOS (Xcode 16.2)
  • GitHub Check: Xcode, macOS (Xcode 16.3)
  • GitHub Check: Xcode, release configuration, macOS (Xcode 16.3)
  • GitHub Check: Xcode, release configuration, macOS (Xcode 16.2)
  • GitHub Check: Xcode, macOS (Xcode 16.2)
  • GitHub Check: SPM (Xcode 16.3)
  • GitHub Check: SPM (Xcode 16.2)
🔇 Additional comments (2)
Sources/AblyChat/Version.swift (1)

7-7: Version constant update approved.
The version constant is now correctly updated to "0.3.0" to match the proposed release version.

CHANGELOG.md (1)

3-6: New version entry for 0.3.0 added.
The new section for version 0.3.0, including the header and the "What's Changed" subsection, is correctly formatted and reflects the intended release notes.

Copy link
Copy Markdown
Collaborator

@maratal maratal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lawrence-forooghian lawrence-forooghian merged commit ccf9547 into main Apr 14, 2025
30 checks passed
@lawrence-forooghian lawrence-forooghian deleted the release/0.3.0 branch April 14, 2025 15:59
@coderabbitai coderabbitai Bot mentioned this pull request May 15, 2025
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.

2 participants