Comfy-Org/ComfyUI_frontend
1
0
Fork 0
mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-02-03 06:47:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
779f539b0e33a7740ddacc7c00a52745de56edd6
ComfyUI_frontend/docs/API-CHANGELOG.md
snomiao ff60bdf1bc [feat] Add automated API changelog generation workflow 
Implements a GitHub Actions workflow that automatically generates API
changelogs by comparing TypeScript type definitions between versions.

Changes:
- Add release-api-changelogs.yaml workflow triggered after npm types release
- Create snapshot-api.js script to extract API surface from TypeScript defs
- Create compare-api-snapshots.js to generate human-readable changelogs
- Initialize docs/API-CHANGELOG.md to track public API changes

The workflow:
1. Triggers after Release NPM Types workflow completes
2. Builds and snapshots current and previous API surfaces
3. Compares snapshots to detect additions, removals, and modifications
4. Generates formatted changelog with breaking changes highlighted
5. Creates draft PR for review before merging

This automates documentation of breaking changes for extension developers
without manual effort, supporting the large extension ecosystem.

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-23 03:03:11 +00:00

1019 B
Raw Blame History

Public API Changelog

This changelog documents changes to the ComfyUI Frontend public API surface across versions. The public API surface includes types, interfaces, and objects used by third-party extensions and custom nodes.

Important: This is an automatically generated changelog based on TypeScript type definitions. Breaking changes are marked with ⚠️.

What is tracked

This changelog tracks changes to the following public API components exported from @comfyorg/comfyui-frontend-types:

  • Type Aliases: Type definitions used by extensions
  • Interfaces: Object shapes and contracts
  • Enums: Enumerated values
  • Functions: Public utility functions
  • Classes: Exported classes and their public members
  • Constants: Public constant values

Migration Guide

When breaking changes occur, refer to the specific version section below for:

  • What changed
  • Why it changed (if applicable)
  • How to migrate your code