[PR #55] [MERGED] docs: follow the repo rename to comfy-swift-sdk and align README with sibling SDKs #57

Closed
opened 2026-10-26 22:34:29 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-swift-sdk/pull/55
Author: @wei-hai
Created: 7/30/2026
Status: ✅ Merged
Merged: 7/30/2026
Merged by: @wei-hai

Base: main ← Head: chore/rename-repo-and-readme


📝 Commits (1)

  • c2089d3 docs: follow the repo rename to comfy-swift-sdk and align README with sibling SDKs

📊 Changes

2 files changed (+17 additions, -4 deletions)

View changed files

📝 README.md (+16 -3)
📝 SECURITY.md (+1 -1)

📄 Description

Follow-up to the repo rename ComfySwiftSDK → comfy-swift-sdk (org convention: comfy-lower-kebab-case). This completes the set — the Python and TypeScript SDKs were renamed earlier.

What changed

Three URLs that named the old repo, plus the README title:

  • README.md — the SwiftPM .package(url:) line (also bumped from: "0.3.0" → "0.3.1", the current release), the "open an issue" link, and the <h1>.
  • SECURITY.md — the private vulnerability-reporting link.

Plus the same linked Related projects table the other two SDK READMEs now carry, so all three open the same way.

What deliberately did NOT change

The Swift module, target, and product names stay ComfySwiftSDK. They are the public import surface — renaming them would break import ComfySwiftSDK for every consumer, including Comfy-iOS. So Package.swift, Sources/, Tests/, and the contract scripts are untouched; the ~35 other occurrences of ComfySwiftSDK in this repo are all module references, not repo references.

Existing SwiftPM consumers are unaffected either way: GitHub redirects the old clone URL, so pinned dependencies keep resolving.

Verification

  • swift build — clean.
  • The diff touches zero .swift files (README.md and SECURITY.md only), so there is no behavior change to test.
  • I could not run swift test locally — this toolchain has no Testing module (swift-testing), so the test targets don't compile here. CI covers it.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-swift-sdk/pull/55 **Author:** [@wei-hai](https://github.com/wei-hai) **Created:** 7/30/2026 **Status:** ✅ Merged **Merged:** 7/30/2026 **Merged by:** [@wei-hai](https://github.com/wei-hai) **Base:** `main` ← **Head:** `chore/rename-repo-and-readme` --- ### 📝 Commits (1) - [`c2089d3`](https://github.com/Comfy-Org/comfy-swift-sdk/commit/c2089d3328d0a6c904ada35c95db5695b39b3438) docs: follow the repo rename to comfy-swift-sdk and align README with sibling SDKs ### 📊 Changes **2 files changed** (+17 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+16 -3) 📝 `SECURITY.md` (+1 -1) </details> ### 📄 Description Follow-up to the repo rename `ComfySwiftSDK` → `comfy-swift-sdk` (org convention: `comfy-lower-kebab-case`). This completes the set — the Python and TypeScript SDKs were renamed earlier. ## What changed Three URLs that named the old repo, plus the README title: - `README.md` — the SwiftPM `.package(url:)` line (also bumped `from: "0.3.0"` → `"0.3.1"`, the current release), the "open an issue" link, and the `<h1>`. - `SECURITY.md` — the private vulnerability-reporting link. Plus the same linked **Related projects** table the other two SDK READMEs now carry, so all three open the same way. ## What deliberately did NOT change **The Swift module, target, and product names stay `ComfySwiftSDK`.** They are the public import surface — renaming them would break `import ComfySwiftSDK` for every consumer, including Comfy-iOS. So `Package.swift`, `Sources/`, `Tests/`, and the contract scripts are untouched; the ~35 other occurrences of `ComfySwiftSDK` in this repo are all module references, not repo references. Existing SwiftPM consumers are unaffected either way: GitHub redirects the old clone URL, so pinned dependencies keep resolving. ## Verification - `swift build` — clean. - The diff touches **zero `.swift` files** (README.md and SECURITY.md only), so there is no behavior change to test. - I could not run `swift test` locally — this toolchain has no `Testing` module (swift-testing), so the test targets don't compile here. CI covers it. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Comfy-Org/comfy-swift-sdk#57
No description provided.