Comfy-Org / Comfy-Org/ComfyUI_frontend

[Feature Request]: Indicate and check required version of template workflows

Open
#3,649 1 comment 0 reactions 1 assignee Claimed by @yiqun12 View on GitHub
enhancement good first issue help wanted
Dominant language
TypeScript
Stars
2k
Forks
699
Avg merge
1d 7h
Merged PRs (30d)
490

Description

### Is there an existing issue for this?

- [ ] I have searched the existing issues and checked the recent builds/commits

### What would your feature do ?

Add a `versionRequired` to template workflows. Then, show all templates, but disable the ones that are only compatible with versions ahead of user's installed version.

### Proposed workflow

**Process for whoever develops the feature**:

1. Add a `versionRequired` to this type: https://github.com/Comfy-Org/ComfyUI_frontend/blob/82c5f02c3d3ac1445dec0df617158832c6033716/src/types/workflowTemplateTypes.ts#L1-L12
2. Change the [TemplateWorkflowCard](https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/components/templates/TemplateWorkflowCard.vue) code to check the current ComfyUI version the user has - available [systemStatsStore](https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/stores/systemStatsStore.ts)
3. If the version is below (can use [compareVersion function here](https://github.com/Comfy-Org/ComfyUI_frontend/blob/main/src/utils/formatUtil.ts#L399-L417) to check), add some indicator that the template can't be used (e.g., grey it out, put a cross through it) and disable the normal interaction that happens when you click (attempt to load workflow)
4. Finally, add some indicator that gently encourages user to upgrade their version if they want to use this template

### Additional information

Benefits:

- Allows ComfyUI and ComfyUI desktop to always install the latest version of the templates package, avoiding developer overhead and additional step in model release process
- Gives users info about new features that are available in future versions
- Encourages users to update

┆Issue is synchronized with this [Notion page](https://www.notion.so/Issue-3649-Feature-Request-Indicate-and-check-required-version-of-template-workflows-1e16d73d3650812bb62fdbf2eda963d7) by [Unito](https://www.unito.io)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.