-
Notifications
You must be signed in to change notification settings - Fork 11.4k
support more example folders #7836
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
support more example folders #7836
Conversation
huchenlei
left a comment
There was a problem hiding this 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?
|
A small note here - when I implemented the |
|
@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. |

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
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.