[PR #10] [MERGED] Public release prep: license, README, comment purge, DocC docs #15

New issue

Closed

opened 2026-10-26 22:33:56 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-26 22:33:56 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-swift-sdk/pull/10
Author: @mattmillerai
Created: 6/21/2026
Status: ✅ Merged
Merged: 6/21/2026
Merged by: @mattmillerai

Base: main ← Head: chore/public-release-prep

📝 Commits (5)

62b57fb chore: add Apache-2.0 license and NOTICE
498a650 docs: rewrite README with branding, badges, and quick start
03b1d09 refactor: strip internal planning comments from SDK sources and tests
b79e7f0 docs: add DocC reference docs to ComfyCloudClient public API
0d79e34 refactor: strip comments from #8-updated files; README + lint fixups

📊 Changes

46 files changed (+517 additions, -2898 deletions)

View changed files

➕ LICENSE (+201 -0)
➕ NOTICE (+4 -0)
📝 README.md (+123 -14)
📝 Sources/ComfySwiftSDK/Internal/Auth/OAuthConfiguration.swift (+0 -71)
📝 Sources/ComfySwiftSDK/Internal/Auth/OAuthExchanger.swift (+0 -49)
📝 Sources/ComfySwiftSDK/Internal/Auth/OAuthMetadataFetcher.swift (+0 -68)
📝 Sources/ComfySwiftSDK/Internal/Auth/OAuthTokenRefreshExecutor.swift (+1 -62)
📝 Sources/ComfySwiftSDK/Internal/ComfySDKInfo.swift (+0 -21)
📝 Sources/ComfySwiftSDK/Internal/DTOs/JobStatusDTO.swift (+0 -112)
➖ Sources/ComfySwiftSDK/Internal/DTOs/OutputDTO.swift (+0 -23)
📝 Sources/ComfySwiftSDK/Internal/DTOs/SubmitJobDTO.swift (+0 -18)
📝 Sources/ComfySwiftSDK/Internal/PollingFallback.swift (+2 -156)
📝 Sources/ComfySwiftSDK/Internal/ReattachCoordinator.swift (+3 -109)
📝 Sources/ComfySwiftSDK/Internal/SDKLog.swift (+0 -86)
📝 Sources/ComfySwiftSDK/Internal/Transport.swift (+3 -304)
📝 Sources/ComfySwiftSDK/Internal/WebSocketSession.swift (+0 -291)
📝 Sources/ComfySwiftSDK/Public/ComfyCloudClient.swift (+99 -186)
📝 Sources/ComfySwiftSDK/Public/ComfyCredential.swift (+8 -75)
📝 Sources/ComfySwiftSDK/Public/ComfyError.swift (+14 -115)
📝 Sources/ComfySwiftSDK/Public/JobEvent.swift (+7 -67)

...and 26 more files

📄 Description

Prepares the repo for public consumption. Four logical commits:

chore: add Apache-2.0 license and NOTICE — the missing license that blocked any public release. Apache-2.0 is the standard for an embeddable client SDK (permissive + patent grant); GPL-3.0 like ComfyUI would force every app embedding the SDK to also be GPL.
docs: rewrite README — Comfy logo + badge row, accurate async/await quick-start, install/auth/contributing sections.
refactor: strip internal planning comments — removes ~2,500 lines of extraction-era comments that referenced internal artifacts (Story/Epic/NFR tags, backend *.go:line refs, sprint docs) no external reader can resolve. Public symbols keep a one-line doc; internal files and tests are comment-free. Also drops the empty OutputDTO placeholder and fixes a never-mutated var warning.
docs: add DocC reference docs to ComfyCloudClient — the public façade now carries DocC blocks (Parameters/Returns/Throws, a usage example, symbol cross-links) that render in Xcode Quick Help.

Verification

swift build clean (no warnings)
swift test — 134 tests pass
No behavior change: every code path is identical; this is license + docs + comment removal only.

Notes / corrected docs

WorkflowInput.image previously documented itself as "rejected at submit time" — that was stale (image upload works now); corrected.
A follow-up PR adds CI (swift build/swift test) and an OpenAPI contract drift-check against the ComfyUI openapi.yaml front-facing spec.

🤖 Generated with Claude Code

_{🔄 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/10 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 6/21/2026 **Status:** ✅ Merged **Merged:** 6/21/2026 **Merged by:** [@mattmillerai](https://github.com/mattmillerai) **Base:** `main` ← **Head:** `chore/public-release-prep` --- ### 📝 Commits (5) - [`62b57fb`](https://github.com/Comfy-Org/comfy-swift-sdk/commit/62b57fb3ca9cde965990b63b13fce94339b7e3e4) chore: add Apache-2.0 license and NOTICE - [`498a650`](https://github.com/Comfy-Org/comfy-swift-sdk/commit/498a6507a57eeab656d364fb58588a13f38a9ab7) docs: rewrite README with branding, badges, and quick start - [`03b1d09`](https://github.com/Comfy-Org/comfy-swift-sdk/commit/03b1d09203cf0ef6c8cbe5d0ec49d76912348973) refactor: strip internal planning comments from SDK sources and tests - [`b79e7f0`](https://github.com/Comfy-Org/comfy-swift-sdk/commit/b79e7f0462a28b5edcf0bd5e0085105871e421e9) docs: add DocC reference docs to ComfyCloudClient public API - [`0d79e34`](https://github.com/Comfy-Org/comfy-swift-sdk/commit/0d79e34cc35b941ac6805c74dad07f6946771e13) refactor: strip comments from #8-updated files; README + lint fixups ### 📊 Changes **46 files changed** (+517 additions, -2898 deletions) <details> <summary>View changed files</summary> ➕ `LICENSE` (+201 -0) ➕ `NOTICE` (+4 -0) 📝 `README.md` (+123 -14) 📝 `Sources/ComfySwiftSDK/Internal/Auth/OAuthConfiguration.swift` (+0 -71) 📝 `Sources/ComfySwiftSDK/Internal/Auth/OAuthExchanger.swift` (+0 -49) 📝 `Sources/ComfySwiftSDK/Internal/Auth/OAuthMetadataFetcher.swift` (+0 -68) 📝 `Sources/ComfySwiftSDK/Internal/Auth/OAuthTokenRefreshExecutor.swift` (+1 -62) 📝 `Sources/ComfySwiftSDK/Internal/ComfySDKInfo.swift` (+0 -21) 📝 `Sources/ComfySwiftSDK/Internal/DTOs/JobStatusDTO.swift` (+0 -112) ➖ `Sources/ComfySwiftSDK/Internal/DTOs/OutputDTO.swift` (+0 -23) 📝 `Sources/ComfySwiftSDK/Internal/DTOs/SubmitJobDTO.swift` (+0 -18) 📝 `Sources/ComfySwiftSDK/Internal/PollingFallback.swift` (+2 -156) 📝 `Sources/ComfySwiftSDK/Internal/ReattachCoordinator.swift` (+3 -109) 📝 `Sources/ComfySwiftSDK/Internal/SDKLog.swift` (+0 -86) 📝 `Sources/ComfySwiftSDK/Internal/Transport.swift` (+3 -304) 📝 `Sources/ComfySwiftSDK/Internal/WebSocketSession.swift` (+0 -291) 📝 `Sources/ComfySwiftSDK/Public/ComfyCloudClient.swift` (+99 -186) 📝 `Sources/ComfySwiftSDK/Public/ComfyCredential.swift` (+8 -75) 📝 `Sources/ComfySwiftSDK/Public/ComfyError.swift` (+14 -115) 📝 `Sources/ComfySwiftSDK/Public/JobEvent.swift` (+7 -67) _...and 26 more files_ </details> ### 📄 Description Prepares the repo for public consumption. Four logical commits: 1. **`chore: add Apache-2.0 license and NOTICE`** — the missing license that blocked any public release. Apache-2.0 is the standard for an embeddable client SDK (permissive + patent grant); GPL-3.0 like ComfyUI would force every app embedding the SDK to also be GPL. 2. **`docs: rewrite README`** — Comfy logo + badge row, accurate async/await quick-start, install/auth/contributing sections. 3. **`refactor: strip internal planning comments`** — removes ~2,500 lines of extraction-era comments that referenced internal artifacts (Story/Epic/NFR tags, backend `*.go:line` refs, sprint docs) no external reader can resolve. Public symbols keep a one-line doc; internal files and tests are comment-free. Also drops the empty `OutputDTO` placeholder and fixes a never-mutated `var` warning. 4. **`docs: add DocC reference docs to ComfyCloudClient`** — the public façade now carries DocC blocks (Parameters/Returns/Throws, a usage example, symbol cross-links) that render in Xcode Quick Help. ### Verification - `swift build` clean (no warnings) - `swift test` — **134 tests pass** - No behavior change: every code path is identical; this is license + docs + comment removal only. ### Notes / corrected docs - `WorkflowInput.image` previously documented itself as "rejected at submit time" — that was stale (image upload works now); corrected. - A follow-up PR adds CI (`swift build`/`swift test`) and an OpenAPI contract drift-check against the ComfyUI `openapi.yaml` front-facing spec. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-26 22:33:56 +00:00