Skip to content

Update for renamed LiveObjects plugin repo#2092

Merged
lawrence-forooghian merged 1 commit intomainfrom
rename-plugin-repo-to-ably-liveobjects-swift-plugin
Aug 22, 2025
Merged

Update for renamed LiveObjects plugin repo#2092
lawrence-forooghian merged 1 commit intomainfrom
rename-plugin-repo-to-ably-liveobjects-swift-plugin

Conversation

@lawrence-forooghian
Copy link
Copy Markdown
Collaborator

@lawrence-forooghian lawrence-forooghian commented Aug 21, 2025

Also see ably/ably-liveobjects-swift-plugin#70.

Summary by CodeRabbit

  • Documentation
    • Updated LiveObjects plugin references to point to the Swift-based repository, ensuring links and guidance reflect the current plugin location.
    • Clarified references in user docs and API comments, including supported keys and plugin name details.
    • No changes to app behavior or public APIs.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Aug 21, 2025

Walkthrough

Updated references to the LiveObjects plugin repository from ably-cocoa-liveobjects-plugin to ably-liveobjects-swift-plugin in documentation and header doc comments. No code, APIs, or runtime behavior changed.

Changes

Cohort / File(s) Summary
Docs: Plugin URL update
Docs/plugins.md
Updated LiveObjects plugin repository URL to ably-liveobjects-swift-plugin.
Header doc comments: Plugin URL update
Source/include/Ably/ARTClientOptions.h
Adjusted doc comments to reference ably-liveobjects-swift-plugin; no signature or behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my nose at links that gleam,
Hop-hop—now Swift’s the plugin theme!
Cocoa’s tracks fade in the dew,
Fresh URLs, a sprightly view.
I stamp and squeak, “Docs align!” 🥕
Commit is crisp—now everything’s fine.

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

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

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 1544881 and a646835.

📒 Files selected for processing (2)
  • Docs/plugins.md (1 hunks)
  • Source/include/Ably/ARTClientOptions.h (2 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: lawrence-forooghian
PR: ably/ably-cocoa#2088
File: Ably.xcodeproj/project.pbxproj:4275-4275
Timestamp: 2025-08-20T16:47:07.996Z
Learning: In ably-cocoa’s Xcode project, the correct header roots are Source/include (public) and Source/PrivateHeaders (private). Ably-iOS previously pointed to Source/Private (nonexistent), and macOS/tvOS to repo-root include; future header search paths should consistently use Source/include and Source/PrivateHeaders across targets.
📚 Learning: 2025-08-20T14:58:23.721Z
Learnt from: lawrence-forooghian
PR: ably/ably-cocoa#2088
File: Package.swift:0-0
Timestamp: 2025-08-20T14:58:23.721Z
Learning: In ably-cocoa, ABLY_IS_SPM_BUILD should not be used anywhere; plugin gating uses ABLY_SUPPORTS_PLUGINS instead.

Applied to files:

  • Docs/plugins.md
📚 Learning: 2025-08-13T16:50:28.236Z
Learnt from: lawrence-forooghian
PR: ably/ably-cocoa#2084
File: Source/ARTClientOptions.m:249-251
Timestamp: 2025-08-13T16:50:28.236Z
Learning: In ARTClientOptions.m, the setPluginOptionsValue:forKey: method intentionally provides a simple dictionary-like interface without defensive copying, expecting callers to handle proper value management themselves rather than adding defensive programming overhead.

Applied to files:

  • Source/include/Ably/ARTClientOptions.h
📚 Learning: 2024-10-08T15:37:26.766Z
Learnt from: maratal
PR: ably/ably-cocoa#1973
File: Source/include/Ably/ARTRealtimeChannelOptions.h:33-33
Timestamp: 2024-10-08T15:37:26.766Z
Learning: `ARTChannelOptions` is already marked with `NS_SWIFT_SENDABLE`.

Applied to files:

  • Source/include/Ably/ARTClientOptions.h
🪛 markdownlint-cli2 (0.17.2)
Docs/plugins.md

9-9: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (3)
Docs/plugins.md (1)

9-9: LGTM! Documentation update correctly reflects the repository rename.

The URL has been properly updated to reference the new repository name ably-liveobjects-swift-plugin instead of the old ably-cocoa-liveobjects-plugin.

Source/include/Ably/ARTClientOptions.h (2)

14-14: LGTM! Documentation correctly updated for the LiveObjects plugin.

The documentation comment has been properly updated to reference the new repository name ably-liveobjects-swift-plugin instead of the old ably-cocoa-liveobjects-plugin.


209-209: LGTM! Documentation consistently updated for plugin repository.

The documentation in the plugins property comment has been correctly updated to reference the new repository name, maintaining consistency with the other documentation changes.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch rename-plugin-repo-to-ably-liveobjects-swift-plugin

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@lawrence-forooghian lawrence-forooghian merged commit b0c2ecf into main Aug 22, 2025
13 of 15 checks passed
@lawrence-forooghian lawrence-forooghian deleted the rename-plugin-repo-to-ably-liveobjects-swift-plugin branch August 22, 2025 12:13
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