[PR #153] [MERGED] docs(changelog): trim to a normal changelog #153

New issue

Closed

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

bsakaguchi commented

2026-10-31 22:01:49 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-python-sdk/pull/153
Author: @mattmillerai
Created: 9/14/2026
Status: ✅ Merged
Merged: 9/14/2026
Merged by: @mattmillerai

Base: main ← Head: matt/changelog-trim

📝 Commits (1)

fdc1b3f docs(changelog): trim to a normal changelog

📊 Changes

1 file changed (+96 additions, -394 deletions)

View changed files

📝 CHANGELOG.md (+96 -394)

📄 Description

ELI-5

The changelog had turned into a set of essays. Each entry explained not just what changed, but why it was designed that way, what it used to do, and the reasoning behind every tradeoff. 0.1.9 alone was 198 lines. Nobody reads a changelog like that — you skim it to find out whether an upgrade breaks you.

This rewrites it as a normal changelog: a line or two per entry. 502 lines → 204.

What is preserved

Every version section — all 12, byte-identical heading list.
Every compare link at the bottom.
Every breaking change, still marked bold: the COMFY_BASE_URL move (0.1.7), api_key keyword-only (0.1.7), api.comfy.org/api/v2 going away (0.1.4), the {provider}/{model} id rule (0.1.9).
The migration specifics a reader has to act on, with their concrete values: point COMFY_ROUTER_BASE_URL at your Router host, except IdempotencyKeyReuse no longer catches a refused resend, check .resend_refused before an outer wrapper re-enters run().

What is cut

Rationale prose — why a design was chosen, what the old behaviour was, what each gate is load-bearing for. That belongs in the code (where much of it already is, at length) and in the GitHub Releases, which the header now points at for the fuller account of any version.

Note on rewriting released history

Sections for shipped versions are rewritten, not just recent ones. That is deliberate: a changelog is read top-to-bottom by someone upgrading across several versions, so a consistent density matters more than preserving the original wording of 0.1.9. The published release notes for each version are unchanged and remain the detailed record.

Provenance

Documentation only — no code, no tests, no behaviour. Verified mechanically that the version-heading list and the link-reference block are identical before and after.

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation
- Updated the changelog with concise summaries for versions 0.1.0 through 0.3.0.
- Added links to GitHub Releases for more complete version details.
- Retained key information about API additions, behavior changes, fixes, validation rules, retry behavior, and configuration updates.

_{🔄 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-python-sdk/pull/153 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 9/14/2026 **Status:** ✅ Merged **Merged:** 9/14/2026 **Merged by:** [@mattmillerai](https://github.com/mattmillerai) **Base:** `main` ← **Head:** `matt/changelog-trim` --- ### 📝 Commits (1) - [`fdc1b3f`](https://github.com/Comfy-Org/comfy-python-sdk/commit/fdc1b3f52c64f374716d5c84345d07b5f18f59b1) docs(changelog): trim to a normal changelog ### 📊 Changes **1 file changed** (+96 additions, -394 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+96 -394) </details> ### 📄 Description ## ELI-5 The changelog had turned into a set of essays. Each entry explained not just what changed, but why it was designed that way, what it used to do, and the reasoning behind every tradeoff. 0.1.9 alone was 198 lines. Nobody reads a changelog like that — you skim it to find out whether an upgrade breaks you. This rewrites it as a normal changelog: a line or two per entry. 502 lines → 204. ## What is preserved - **Every version section** — all 12, byte-identical heading list. - **Every compare link** at the bottom. - **Every breaking change**, still marked bold: the `COMFY_BASE_URL` move (0.1.7), `api_key` keyword-only (0.1.7), `api.comfy.org/api/v2` going away (0.1.4), the `{provider}/{model}` id rule (0.1.9). - **The migration specifics a reader has to act on**, with their concrete values: point `COMFY_ROUTER_BASE_URL` at your Router host, `except IdempotencyKeyReuse` no longer catches a refused resend, check `.resend_refused` before an outer wrapper re-enters `run()`. ## What is cut Rationale prose — why a design was chosen, what the old behaviour was, what each gate is load-bearing for. That belongs in the code (where much of it already is, at length) and in the GitHub Releases, which the header now points at for the fuller account of any version. ## Note on rewriting released history Sections for shipped versions are rewritten, not just recent ones. That is deliberate: a changelog is read top-to-bottom by someone upgrading across several versions, so a consistent density matters more than preserving the original wording of 0.1.9. The published release notes for each version are unchanged and remain the detailed record. ## Provenance Documentation only — no code, no tests, no behaviour. Verified mechanically that the version-heading list and the link-reference block are identical before and after. 🤖 Generated with [Claude Code](https://claude.com/claude-code)  ## Summary by CodeRabbit * **Documentation** * Updated the changelog with concise summaries for versions 0.1.0 through 0.3.0. * Added links to GitHub Releases for more complete version details. * Retained key information about API additions, behavior changes, fixes, validation rules, retry behavior, and configuration updates.  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:01:49 +00:00