Skip to content

Update the repository for its rename to ably-pubsub-cocoa - #2340

Merged
maratal merged 6 commits into
integration/v2from
rename/ably-pubsub-cocoa
Oct 29, 2026
Merged

maratal merged 6 commits into
integration/v2from
rename/ably-pubsub-cocoa

Conversation

@maratal

@maratal maratal commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Merge on rename day, after ably/ably-cocoa is renamed to ably/ably-pubsub-cocoa (rollout plan §11, step 16). Until then this PR's CI is expected to fail: CI checks the repository out into a directory named after it, and the AWS role below only trusts the new name.

Commits

  1. Resolve the LiveObjects example's package by a relative path — AblyLiveObjectsExample.xcodeproj found the root package at ../../../ably-cocoa, which only exists when the checkout directory is named ably-cocoa. ../.. works under any name. (Also why Carthage could not build 1.x from a checkout with another name.)

  2. Use the ably-pubsub-cocoa AWS role and features name in CI — docs.yml, liveobjects.yaml, features.yml. Same change as Point CI workflows at the ably-pubsub-cocoa sdk-builds role #2269, which targets main.

  3. Install from the ably-pubsub-cocoa package — README and LiveObjects README install snippets name the new URL and package: "ably-pubsub-cocoa"; Examples/SPM uses the new identity (for a path dependency it is the directory name). After the rename the old URL is the 1.x maintenance copy.

  4. Point repository links and badges at ably/ably-pubsub-cocoa — 41 links in docs, READMEs, and comments in Source/ and Test/ (comments only; no code changes). The copy under the old name has no issues or PRs. ably-cocoa-plugin-support links are untouched.

  5. Point CHANGELOG links at ably/ably-pubsub-cocoa — 541 PR, issue, tag and compare links. Plain-text mentions of ably-cocoa (including quoted error messages) are unchanged.

  6. Remove the manual install instructions — 2.x ships through Swift Package Manager only, and the section named a directory that does not exist (ably-cocoa/ably-cocoa), the wrong msgpack fork and version (ably-forks 0.2.0; the package uses rvi/msgpack-objective-C 0.4.0), and none of the other dependencies (delta-codec-cocoa, _AblyPluginSupportPrivate, ABLY_SUPPORTS_PLUGINS). The Installation intro no longer links to it.

Plain-text mentions of "ably-cocoa" as the SDK's former name are left as they are, including the migration guide.

Verified

  • From a checkout in a directory not named ably-cocoa, xcodebuild -list -workspace LiveObjects/AblyLiveObjects.xcworkspace fails before commit 1 (Could not resolve package dependencies) and lists the schemes after it.
  • From a checkout in a directory named ably-pubsub-cocoa, Examples/SPM resolves and swift build --target SPMIntegration succeeds.
  • git diff --check is clean.

Not in this PR

  • Swift Package Index: a PR to SwiftPackageIndex/PackageList for the new URL (the README badges point at it).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated repository links, package references, and release information across the documentation and examples.
    • Installation guidance now directs users to Swift Package Manager; manual installation instructions have been removed.
  • Chores
    • Updated build and documentation workflows to use the current repository configuration.

maratal and others added 5 commits October 29, 2026 14:59
The example found the root package at ../../../ably-cocoa, which only
exists when the checkout directory is named ably-cocoa. ../.. finds it
whatever the directory is called.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The ably-sdk-builds-ably-pubsub-cocoa role trusts this repository only
under its new name. Same change as #2269 on main.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
After the rename the old URL is the 1.x maintenance copy, so the install
snippets name the new URL. A package's identity follows its URL, or its
directory for a path dependency, so the package: labels change with it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
After the rename the old URL is the 1.x maintenance copy, which has no
issues or pull requests, so links to them would not resolve.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The pull requests, issues and tags these link to stay with the renamed
repository.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b7f7cdfb-c680-4554-b919-cfc79cd58acb
Commits

Reviewing files that changed from the base of the PR and between 8579661 and 9637380.

Files selected for processing: 25
  • .github/workflows/docs.yml
  • .github/workflows/features.yml
  • .github/workflows/liveobjects.yaml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • Docs/Main.md
  • Docs/tools-for-investigating-test-failures.md
  • Examples/SPM/Package.swift
  • LiveObjects/Example/AblyLiveObjectsExample.xcodeproj/project.pbxproj
  • LiveObjects/README.md
  • README.md
  • Source/ARTAuth.m
  • Source/ARTJsonLikeEncoder.m
  • Source/ARTLocalDevice.m
  • Source/ARTLocalDeviceStorage.m
  • Source/PrivateHeaders/Ably/ARTInternalLog.h
  • Test/AblyTests/Tests/AuthTests.swift
  • Test/AblyTests/Tests/HttpClientChannelTests.swift
  • Test/AblyTests/Tests/HttpClientTests.swift
  • Test/AblyTests/Tests/PushActivationStateMachineTests.swift
  • Test/AblyTests/Tests/PushTests.swift
  • Test/AblyTests/Tests/RealtimeClientChannelTests.swift
  • Test/AblyTests/Tests/RealtimeClientConnectionTests.swift
  • Test/AblyTests/Tests/RealtimeClientTests.swift
  • _AblyPluginSupportPrivate/README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The repository links, Swift package identifiers, local Xcode package path, and workflow settings now use ably-pubsub-cocoa. The main README removes manual installation guidance and retains Swift Package Manager instructions. Runtime code and test logic are unchanged.

Changes

Repository and package references

Layer / File(s) Summary
Workflow and package references
.github/workflows/*, Examples/SPM/Package.swift, LiveObjects/Example/.../project.pbxproj
Workflow role and repository inputs, the SPM product dependency, and the LiveObjects example’s local package path now reference the updated repository or path.
Repository and installation documentation
CONTRIBUTING.md, Docs/*, README.md, LiveObjects/README.md, _AblyPluginSupportPrivate/README.md
Repository links and package instructions identify ably-pubsub-cocoa. The main README removes manual-install instructions and retains Swift Package Manager guidance.
Issue links in code and tests
Source/*, Source/PrivateHeaders/Ably/ARTInternalLog.h, Test/AblyTests/Tests/*
Issue and discussion URLs in source comments, header documentation, and test comments now point to the updated repository. Executable code and test logic are unchanged.

Priority: Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Possibly related PRs

  • ably/ably-cocoa#2339: Adds the 1.4.1 release entry and repository links; this change updates those links to ably-pubsub-cocoa.
Merge Risk: Minimal · up to 96373

Merge after the repository rename and required AWS trust configuration, as planned. No additional correction is supported by the inspected changes.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly summarizes the main change: updating repository references and configuration for the rename to ably-pubsub-cocoa.
Docstring Coverage Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 2 functions across 10 files. (14 skipped: 14 unsupported.)

Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit updates links with care,
To the new package name out there.
The workflows point the way,
Swift packages join the play,
Old manual steps hop away.

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

2.x is distributed through Swift Package Manager only. The section also
named a directory that does not exist, the wrong msgpack fork and
version, and none of the SDK's other dependencies.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@maratal
maratal requested a review from ttypic October 29, 2026 12:22
@maratal
maratal marked this pull request as ready for review October 29, 2026 12:22

@ttypic ttypic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@maratal maratal mentioned this pull request Oct 29, 2026
@maratal
maratal merged commit b5dd88f into integration/v2 Oct 29, 2026
28 of 32 checks passed
@maratal
maratal deleted the rename/ably-pubsub-cocoa branch October 29, 2026 12:32
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