[PR #32] [MERGED] chore: rename repo to comfy-typescript-sdk and align README with sibling SDKs #41

New issue

Closed

opened 2026-10-31 22:04:04 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:04:04 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-typescript-sdk/pull/32
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 (2)

b39af64 chore: rename repo to comfy-typescript-sdk and align README with sibling SDKs
ff8fdcb chore: run oxfmt on README

📊 Changes

6 files changed (+56 additions, -9 deletions)

View changed files

📝 .coderabbit.yaml (+1 -1)
📝 README.md (+36 -2)
➕ assets/logo.svg (+12 -0)
📝 package.json (+3 -3)
📝 scripts/check-public-repo-hygiene.mjs (+3 -2)
📝 src/index.ts (+1 -1)

📄 Description

Follow-up to the repo rename ComfyTypeScriptSDK → comfy-typescript-sdk (org convention: comfy-lower-kebab-case).

What changed

URLs that pointed at the old repo name: package.json homepage / bugs / repository, the Python SDK cross-reference in the README and in src/index.ts's module docblock, and the CodeRabbit context line.
scripts/check-public-repo-hygiene.mjs: the public-repo allowlist is a literal name list, so unlike a URL it does not follow GitHub's redirect — the old names would have started failing the gate. Also adds comfy-swift-sdk, now that the READMEs link to it.
README: adopts the same branded header (logo + badge row) the Swift SDK already uses, and adds the same linked "Related projects" table as the Python SDK. This is the consistency pass Alexis asked for — all three SDK READMEs now open identically and share one technical body style.

Not changed

The npm package name is still @comfyorg/sdk. This is a repo rename only; npm i @comfyorg/sdk is unaffected and no consumer has to do anything.

Risk / verification

node scripts/check-public-repo-hygiene.mjs → OK: no internal-only references found.
package.json re-parsed to confirm it is still valid JSON.
The only src/ change is a comment in the module docblock.

Needs to happen alongside this

The npm Trusted Publisher for @comfyorg/sdk is bound to the old repo name and must be repointed at comfy-typescript-sdk, otherwise the next release fails OIDC verification. Tracked separately.

_{🔄 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-typescript-sdk/pull/32 **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 (2) - [`b39af64`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/b39af6438c96ffe4750200dd86f8b503dc5f3e31) chore: rename repo to comfy-typescript-sdk and align README with sibling SDKs - [`ff8fdcb`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/ff8fdcb019510ce1a07a8d622dec202101528cf0) chore: run oxfmt on README ### 📊 Changes **6 files changed** (+56 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `.coderabbit.yaml` (+1 -1) 📝 `README.md` (+36 -2) ➕ `assets/logo.svg` (+12 -0) 📝 `package.json` (+3 -3) 📝 `scripts/check-public-repo-hygiene.mjs` (+3 -2) 📝 `src/index.ts` (+1 -1) </details> ### 📄 Description Follow-up to the repo rename `ComfyTypeScriptSDK` → `comfy-typescript-sdk` (org convention: `comfy-lower-kebab-case`). ## What changed - **URLs that pointed at the old repo name**: `package.json` `homepage` / `bugs` / `repository`, the Python SDK cross-reference in the README and in `src/index.ts`'s module docblock, and the CodeRabbit context line. - **`scripts/check-public-repo-hygiene.mjs`**: the public-repo allowlist is a literal name list, so unlike a URL it does *not* follow GitHub's redirect — the old names would have started failing the gate. Also adds `comfy-swift-sdk`, now that the READMEs link to it. - **README**: adopts the same branded header (logo + badge row) the Swift SDK already uses, and adds the same linked "Related projects" table as the Python SDK. This is the consistency pass Alexis asked for — all three SDK READMEs now open identically and share one technical body style. ## Not changed **The npm package name is still `@comfyorg/sdk`.** This is a repo rename only; `npm i @comfyorg/sdk` is unaffected and no consumer has to do anything. ## Risk / verification - `node scripts/check-public-repo-hygiene.mjs` → `OK: no internal-only references found`. - `package.json` re-parsed to confirm it is still valid JSON. - The only `src/` change is a comment in the module docblock. ## Needs to happen alongside this The **npm Trusted Publisher for `@comfyorg/sdk` is bound to the old repo name** and must be repointed at `comfy-typescript-sdk`, otherwise the next release fails OIDC verification. Tracked separately. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:04:04 +00:00