[PR #4] [MERGED] ci: tag-driven release workflow + accurate install docs #14

New issue

Closed

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

bsakaguchi commented

2026-10-31 22:03:50 +00:00

Owner

📋 Pull Request Information

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

Base: main ← Head: ci/tag-driven-release

📝 Commits (3)

0def441 ci: tag-driven release workflow + accurate install docs
bc32946 ci: fix oxfmt formatting on publish.yml
4fa6608 ci: thread built version into publish check; accept full SemVer tags

📊 Changes

2 files changed (+152 additions, -46 deletions)

View changed files

📝 .github/workflows/publish.yml (+146 -41)
📝 README.md (+6 -5)

📄 Description

Follow-up to #3 (merged) — the tag-driven release workflow and the install-doc update landed on the PR branch after #3 was squash-merged, so they weren't part of the merge.

Tag-driven versioning: the GitHub Release tag (vX.Y.Z) is the single source of truth. publish.yml injects it into package.json (via npm pkg set version) at build/pack time (replacing a tag-vs-manifest check), so the committed version is just a placeholder and cutting a release is a single action — create a GitHub Release with the tag you want, no version-bump commit/PR. Publishes to npm with SLSA provenance, gated behind an npm environment with required reviewers; workflow_dispatch is a build + pack + npm publish --dry-run.

Docs: the README's "not yet published" note is replaced with npm i @comfyorg/sdk and the real release process; the from-source path is kept for local dev.

Maintainer setup to enable publishing: create @comfyorg/sdk on npm, add the NPM_TOKEN publish-only automation token to the npm GitHub environment (with required reviewers).

🤖 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-typescript-sdk/pull/4 **Author:** [@wei-hai](https://github.com/wei-hai) **Created:** 7/17/2026 **Status:** ✅ Merged **Merged:** 7/17/2026 **Merged by:** [@wei-hai](https://github.com/wei-hai) **Base:** `main` ← **Head:** `ci/tag-driven-release` --- ### 📝 Commits (3) - [`0def441`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/0def441e449538d6ebd4195bf2b6afa504580f60) ci: tag-driven release workflow + accurate install docs - [`bc32946`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/bc329461b4c76b59db546915a8de063e44c6061c) ci: fix oxfmt formatting on publish.yml - [`4fa6608`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/4fa660814c3ec469d8adec865c620f759201f679) ci: thread built version into publish check; accept full SemVer tags ### 📊 Changes **2 files changed** (+152 additions, -46 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/publish.yml` (+146 -41) 📝 `README.md` (+6 -5) </details> ### 📄 Description Follow-up to #3 (merged) — the tag-driven release workflow and the install-doc update landed on the PR branch after #3 was squash-merged, so they weren't part of the merge. **Tag-driven versioning:** the GitHub Release tag (`vX.Y.Z`) is the single source of truth. `publish.yml` injects it into `package.json` (via `npm pkg set version`) at build/pack time (replacing a tag-vs-manifest check), so the committed version is just a placeholder and cutting a release is a single action — create a GitHub Release with the tag you want, no version-bump commit/PR. Publishes to npm with SLSA provenance, gated behind an `npm` environment with required reviewers; `workflow_dispatch` is a build + pack + `npm publish --dry-run`. **Docs:** the README's "not yet published" note is replaced with `npm i @comfyorg/sdk` and the real release process; the from-source path is kept for local dev. Maintainer setup to enable publishing: create `@comfyorg/sdk` on npm, add the `NPM_TOKEN` publish-only automation token to the `npm` GitHub environment (with required reviewers). 🤖 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-31 22:03:50 +00:00