[PR #218] [MERGED] docs(changelog): cut 0.5.0, and reconstruct the 0.4.0 section #218

New issue

Closed

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

bsakaguchi commented

2026-10-31 22:02:24 +00:00

Owner

📋 Pull Request Information

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

Base: main ← Head: matt/changelog-0.4.0-0.5.0

📝 Commits (2)

99a301a docs(changelog): cut 0.5.0, and reconstruct the 0.4.0 section
7ff77bc docs(changelog): note the comfy_low BinaryResult widening in 0.5.0

📊 Changes

1 file changed (+85 additions, -57 deletions)

View changed files

📝 CHANGELOG.md (+85 -57)

📄 Description

Summary

v0.4.0 was tagged and released, but CHANGELOG.md never got a ## [0.4.0] heading. This PR fixes that and cuts 0.5.0 from current main. Only CHANGELOG.md changes.

## [Unreleased] is now empty. It had no guidance comment to keep.
## [0.5.0] - 2026-10-10 holds all 18 entries that were under Unreleased: Added 5, Fixed 7, Changed 6. The first commit moves them verbatim; a script check confirms the non-heading lines are the same multiset before and after. The two ### Added blocks are merged into one, and the **Breaking** marker on the constructor change is kept. Headings stay in the old Unreleased order (Added, Fixed, Changed), because the first Changed entry ("Because those three buckets...") points back to a Fixed entry.
## [0.4.0] - 2026-09-18 is new text, 4 entries (Added 3, Changed 1). None of the existing entries belonged there (see below), so it is written from the published v0.4.0 GitHub Release notes and the #159 commit: the alt-provider controls, run_detailed() / RouterRunResult, the three newly typed buckets (Cancelled, QueueTimeout, RequestNotFound), and the breaking ComfyLow.post_model_run return-shape change for direct comfy_low callers.
A review-round follow-up commit adds one new 0.5.0 Changed entry (Changed is now 7). It covers the matching breaking change for direct comfy_low callers: post_model_run and get_model_request_result now return dict[str, Any] | BinaryResult as the tuple's body, where v0.4.0 returned dict[str, Any]. The same commit rewords one phrase in the BinaryResult entry ("beyond the fix" becomes "beyond no longer discarding binary generations"), because that entry now comes before the fix it refers to.
Link references: [unreleased] now compares from v0.5.0, and [0.5.0] and [0.4.0] compare links are added.

How the placement was determined

git log v0.3.0..v0.4.0 has only two commits: #153 (the changelog trim) and #159 (the alt-provider controls). #159 adds no changelog entry, and git show v0.4.0:CHANGELOG.md has an empty ## [Unreleased].
For every Unreleased entry, git log -S on its text finds the commit that added it: #145, #154, #157, #166, #167, #174, #201, #202, #204. git merge-base --is-ancestor <commit> v0.4.0 is false for every one of them, and true against origin/main. So every entry came after v0.4.0.
The second ### Added block was not a release seam. #145 put its entry below ### Fixed.
No entry was uncertain. #154 and #157 have author dates on the release day (2026-09-18), but neither is an ancestor of the tag.

No version field changes. Releases are tag-driven: publish.yml writes the tag into pyproject.toml at build time, and CONTRIBUTING.md's release steps only ask for the Unreleased entries to be moved under the new heading.

Checks: python3 scripts/check_public_repo_hygiene.py passes, and so does git diff --check. CI has no Markdown linter or formatter (ruff covers Python only).

ELI5

The changelog is the list of what changed in each release. When 0.4.0 shipped, nobody started a new page for it, and every later change went into the "not yet released" pile. This PR checks each item in that pile against the release history. All of them came after 0.4.0, so they go under 0.5.0, the release about to go out. It also writes the missing 0.4.0 page from that release's published notes.

Provenance

Written by an AI coding agent at a maintainer's request. The maintainer reviews it before merge. Entry placement comes from git ancestry against the v0.4.0 tag, not from wording or position. The 0.4.0 text comes from the published GitHub Release for v0.4.0 and the #159 commit message and diff.

Verified:

Placement: every moved entry's adding commit is not an ancestor of v0.4.0 (git merge-base --is-ancestor).
The new comfy_low entry matches the code: git show v0.4.0:src/comfy_low/transport.py returns tuple[dict[str, Any], ...], while the head returns dict[str, Any] | BinaryResult in the body position.
python3 scripts/check_public_repo_hygiene.py passes on the head.
CI on the head: see the PR checks. This change touches only CHANGELOG.md.

Deviations:

The 0.5.0 section is not purely verbatim any more. It has one added Changed entry and one reworded phrase, both from review feedback.

Summary by CodeRabbit

Documentation
- Added release notes for versions 0.4.0 and 0.5.0, covering job metadata and listing, Router model catalog and schema access, credits reporting, and binary model outputs for direct and queued runs.
- Documented run options, detailed results, Router exceptions, queue backlog errors, and the updated comfy_low return shape.
- Updated release comparison links and the Unreleased link.

_{🔄 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/218 **Author:** [@mattmillerai](https://github.com/mattmillerai) **Created:** 10/10/2026 **Status:** ✅ Merged **Merged:** 10/10/2026 **Merged by:** [@vqt123](https://github.com/vqt123) **Base:** `main` ← **Head:** `matt/changelog-0.4.0-0.5.0` --- ### 📝 Commits (2) - [`99a301a`](https://github.com/Comfy-Org/comfy-python-sdk/commit/99a301a80ab40304cf58f1474067c7d7304a5a2d) docs(changelog): cut 0.5.0, and reconstruct the 0.4.0 section - [`7ff77bc`](https://github.com/Comfy-Org/comfy-python-sdk/commit/7ff77bc362555c2e63188b10e67b9c16a3f513b3) docs(changelog): note the comfy_low BinaryResult widening in 0.5.0 ### 📊 Changes **1 file changed** (+85 additions, -57 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+85 -57) </details> ### 📄 Description ## Summary `v0.4.0` was tagged and released, but `CHANGELOG.md` never got a `## [0.4.0]` heading. This PR fixes that and cuts `0.5.0` from current `main`. Only `CHANGELOG.md` changes. - `## [Unreleased]` is now empty. It had no guidance comment to keep. - `## [0.5.0] - 2026-10-10` holds **all 18** entries that were under Unreleased: Added 5, Fixed 7, Changed 6. The first commit moves them verbatim; a script check confirms the non-heading lines are the same multiset before and after. The two `### Added` blocks are merged into one, and the `**Breaking**` marker on the constructor change is kept. Headings stay in the old Unreleased order (Added, Fixed, Changed), because the first Changed entry ("Because those three buckets...") points back to a Fixed entry. - `## [0.4.0] - 2026-09-18` is **new text**, 4 entries (Added 3, Changed 1). None of the existing entries belonged there (see below), so it is written from the published v0.4.0 GitHub Release notes and the #159 commit: the alt-provider controls, `run_detailed()` / `RouterRunResult`, the three newly typed buckets (`Cancelled`, `QueueTimeout`, `RequestNotFound`), and the breaking `ComfyLow.post_model_run` return-shape change for direct `comfy_low` callers. - A review-round follow-up commit adds one new 0.5.0 Changed entry (Changed is now 7). It covers the matching breaking change for direct `comfy_low` callers: `post_model_run` and `get_model_request_result` now return `dict[str, Any] | BinaryResult` as the tuple's body, where v0.4.0 returned `dict[str, Any]`. The same commit rewords one phrase in the `BinaryResult` entry ("beyond the fix" becomes "beyond no longer discarding binary generations"), because that entry now comes before the fix it refers to. - Link references: `[unreleased]` now compares from `v0.5.0`, and `[0.5.0]` and `[0.4.0]` compare links are added. ### How the placement was determined - `git log v0.3.0..v0.4.0` has only two commits: #153 (the changelog trim) and #159 (the alt-provider controls). #159 adds no changelog entry, and `git show v0.4.0:CHANGELOG.md` has an empty `## [Unreleased]`. - For every Unreleased entry, `git log -S` on its text finds the commit that added it: #145, #154, #157, #166, #167, #174, #201, #202, #204. `git merge-base --is-ancestor <commit> v0.4.0` is false for every one of them, and true against `origin/main`. So every entry came after v0.4.0. - The second `### Added` block was not a release seam. #145 put its entry below `### Fixed`. - No entry was uncertain. #154 and #157 have author dates on the release day (2026-09-18), but neither is an ancestor of the tag. No version field changes. Releases are tag-driven: `publish.yml` writes the tag into `pyproject.toml` at build time, and CONTRIBUTING.md's release steps only ask for the Unreleased entries to be moved under the new heading. Checks: `python3 scripts/check_public_repo_hygiene.py` passes, and so does `git diff --check`. CI has no Markdown linter or formatter (ruff covers Python only). ## ELI5 The changelog is the list of what changed in each release. When 0.4.0 shipped, nobody started a new page for it, and every later change went into the "not yet released" pile. This PR checks each item in that pile against the release history. All of them came after 0.4.0, so they go under 0.5.0, the release about to go out. It also writes the missing 0.4.0 page from that release's published notes. ## Provenance Written by an AI coding agent at a maintainer's request. The maintainer reviews it before merge. Entry placement comes from git ancestry against the `v0.4.0` tag, not from wording or position. The 0.4.0 text comes from the published GitHub Release for `v0.4.0` and the #159 commit message and diff. **Verified:** - Placement: every moved entry's adding commit is not an ancestor of `v0.4.0` (`git merge-base --is-ancestor`). - The new `comfy_low` entry matches the code: `git show v0.4.0:src/comfy_low/transport.py` returns `tuple[dict[str, Any], ...]`, while the head returns `dict[str, Any] | BinaryResult` in the body position. - `python3 scripts/check_public_repo_hygiene.py` passes on the head. - CI on the head: see the PR checks. This change touches only `CHANGELOG.md`. **Deviations:** - The 0.5.0 section is not purely verbatim any more. It has one added Changed entry and one reworded phrase, both from review feedback.  ## Summary by CodeRabbit * **Documentation** * Added release notes for versions 0.4.0 and 0.5.0, covering job metadata and listing, Router model catalog and schema access, credits reporting, and binary model outputs for direct and queued runs. * Documented run options, detailed results, Router exceptions, queue backlog errors, and the updated `comfy_low` return shape. * Updated release comparison links and the Unreleased link.  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:02:24 +00:00