Skip to content

Conversation

@jtydhr88
Copy link
Contributor

After researching the top 100 custom nodes on GitHub by star count, we discovered that only a small portion of custom nodes that provide example workflows follow our existing principle of placing example workflows in the "example_workflows" folder.

The majority place them in other folders. Through statistical analysis, we found that

  • example
  • examples
  • workflow
  • workflows

are the most common folder names.

To better support example workflows provided by custom nodes in workflow templates, we should also include these four folders.

Copy link
Contributor

@huchenlei huchenlei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add warning message when legacy folder names are detected and prompt to rename them to the standard name example_workflows?

@jtydhr88
Copy link
Contributor Author

Can you add warning message when legacy folder names are detected and prompt to rename them to the standard name example_workflows?
image

done

@huchenlei huchenlei merged commit 5c5457a into Comfy-Org:master Apr 29, 2025
5 checks passed
@bezo97
Copy link
Contributor

bezo97 commented Apr 29, 2025

A small note here - when I implemented the example_workflows name I chose this intentionally instead of examples or similar. Because these may contain other type of examples (not workflows). For example imagine the case that a research paper's repository may come with example dataset, example configurations, example outputs etc. and the ComfyUI plugin is just one of the things in there. (I can't point to an exact case off the top of my head, but I've seen it before).
So in summary I'd say the warnings are alright for the workflow and workflows folder but might be problematic for example and examples.

@jtydhr88
Copy link
Contributor Author

@bezo97 I believe this is a temporary solution. First, this requirement comes from many users reporting they don't see the example workflows provided by custom nodes in the workflow template, even though we've already provided this support in the core. Second, although we've written in both our code and documentation that the folder should be set as example_workflows, as I mentioned at the beginning, only a small portion of developers follow this principle. In contrast, they've already extensively used "examples," "example," "workflow," and "workflows."

I think the real solution is that I can later submit PRs to their repositories to help them rename the folder to our expected example_workflows. But for now, we probably still need this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants