Files
ComfyUI_frontend/demo-snapshots/CHANGELOG-DEMO.md
snomiao 75daf2e4d2 [docs] Add API changelog generation demo
Add comprehensive demo showing API changelog generation across two versions (v1.29.0 → v1.30.2):

- Mock TypeScript definitions for both versions
- Generated JSON snapshots showing structured API surface
- Generated changelog with breaking changes, additions, and modifications
- Detailed README explaining the system and benefits

The demo showcases:
 Detection of breaking changes (queuePrompt → queuePromptAsync)
 Tracking of new additions (ExtensionMetadata interface, WorkflowId type)
 Identification of modifications (NodeDef enhancements, NodeStatus enum extensions)

This demonstrates the automated system that will run on every release to document API changes for extension developers.

Also exclude demo-snapshots directory from ESLint checking.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-01 12:21:37 +00:00

1.0 KiB

v1.30.2 (2025-11-01)

Comparing v1.29.0 → v1.30.2. This changelog documents changes to the public API surface that third-party extensions and custom nodes depend on.

Additions

Type Aliases

  • WorkflowId

Interfaces

  • ExtensionMetadata
    • Members: id, name, version, description

🔄 Modifications

Note

: Some modifications may be breaking changes.

Interfaces

  • ComfyApi
    • Added member: queuePromptAsync
    • Added member: cancelPrompt
    • Added member: getQueueStatus
    • ⚠️ Breaking: Removed member: queuePrompt
  • NodeDef
    • Added member: input
    • Added member: output
    • Added member: output_name
  • WorkflowMetadata
    • Added member: tags
    • Added member: thumbnail

Enums

  • NodeStatus
    • Added enum value: ERROR
    • Added enum value: COMPLETED

Classes

  • WorkflowManager
    • Added member: cache
    • Added method: deleteWorkflow()
    • Added method: searchWorkflows()