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

release/0.1.0 #208

Merged
merged 1 commit into from
Jan 15, 2025
Merged

release/0.1.0 #208

merged 1 commit into from
Jan 15, 2025

Conversation

umair-ably
Copy link
Collaborator

@umair-ably umair-ably commented Jan 7, 2025

Ably Chat-Swift Release V0.1.0

Summary by CodeRabbit

  • Documentation

    • Updated CHANGELOG.md with initial release notes for Ably Chat SDK in Swift
    • Removed private beta status and development stage indicators from README.md
    • Simplified documentation to focus on core SDK capabilities
  • New Features

    • Introduced Swift SDK with comprehensive chat functionalities:
      • Support for multiple chat room types
      • Real-time messaging
      • Online presence tracking
      • Typing indicators
      • Ephemeral room-level reactions

@github-actions github-actions bot temporarily deployed to staging/pull/208/AblyChat January 7, 2025 14:08 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/208/AblyChat January 7, 2025 15:18 Inactive
CHANGELOG.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to staging/pull/208/AblyChat January 7, 2025 15:28 Inactive
Copy link

@ttypic ttypic left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
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, make sure it's in line with contribution guide here.

@github-actions github-actions bot temporarily deployed to staging/pull/208/AblyChat January 14, 2025 14:55 Inactive
Copy link

coderabbitai bot commented Jan 14, 2025

Walkthrough

This pull request marks the initial release of the Ably Chat SDK for Swift by updating the CHANGELOG.md and README.md files. The changes remove references to the private beta status, signaling a transition from development to a more public-facing release. The modifications include removing development status badges, beta signup information, and updating the changelog to reflect the SDK's initial release.

Changes

File Changes
CHANGELOG.md Added initial release notes for Ably Chat SDK in Swift
README.md - Removed "Private Beta" development status badge
- Deleted text about SDK development status
- Removed private beta signup links

Possibly related PRs

Suggested reviewers

  • lawrence-forooghian
  • maratal

Poem

🐰 A Swift Chat SDK takes flight,
No more beta, now shining bright!
Badges down, the path is clear,
Messaging magic drawing near
Hop along, new features await! 🚀


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 71a3dd0 and 77c191e.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[grammar] ~7-~7: Possible agreement error. The noun participation seems to be uncountable; consider using: “much participation”, “a good deal of participation”.
Context: ... rooms for 1:1, 1:many, many:1 and many:many participation. - Sending and receiving chat messages....

(MANY_NN_U)

⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Example app, tvOS (Xcode 16)
  • GitHub Check: Example app, iOS (Xcode 16)
  • GitHub Check: Example app, macOS (Xcode 16)
  • GitHub Check: Xcode, tvOS (Xcode 16)
  • GitHub Check: Xcode, release configuration, tvOS (Xcode 16)
  • GitHub Check: Xcode, iOS (Xcode 16)
  • GitHub Check: SPM (Xcode 16)
  • GitHub Check: Xcode, release configuration, iOS (Xcode 16)
  • GitHub Check: Xcode, macOS (Xcode 16)
  • GitHub Check: Xcode, release configuration, macOS (Xcode 16)
  • GitHub Check: SPM, release configuration (Xcode 16)
🔇 Additional comments (3)
CHANGELOG.md (1)

5-12: LGTM! Well-structured changelog entry.

The changelog entry effectively communicates the initial release features and aligns with the README content.

🧰 Tools
🪛 LanguageTool

[grammar] ~7-~7: Possible agreement error. The noun participation seems to be uncountable; consider using: “much participation”, “a good deal of participation”.
Context: ... rooms for 1:1, 1:many, many:1 and many:many participation. - Sending and receiving chat messages....

(MANY_NN_U)

README.md (2)

Line range hint 32-34: LGTM! Correct package version in installation instructions.

The Swift package installation instructions correctly reference version 0.1.0.


498-498: LGTM! Appropriate feedback channel maintained.

The feedback link is properly maintained while successfully transitioning away from private beta messaging.


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.

@umair-ably umair-ably merged commit f2024f3 into main Jan 15, 2025
17 checks passed
@umair-ably umair-ably deleted the release/0.1.0 branch January 15, 2025 11:06
@coderabbitai coderabbitai bot mentioned this pull request Jan 20, 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.

3 participants