提交社区节点#
可能会有变动
本文档描述的标准适用于社区节点仓库的首个版本。这些标准在未来的版本中可能会有所变更。
社区节点是托管在npm注册表中的npm包。
在构建节点并提交至社区节点仓库时,请使用以下资源确保您的节点配置正确:
标准#
要让您的节点在n8n社区节点仓库中可用,您必须:
- 确保包名以
n8n-nodes-或@<scope>/n8n-nodes-开头。例如:n8n-nodes-weather或@weatherPlugins/n8n-nodes-weather。 - 在你的包关键词中包含
n8n-community-node-package。 - 确保将您的节点和凭据添加到
package.json文件中的n8n属性内。参考starter node中的package.json作为示例。 - 使用linter检查您的节点并在本地测试以确保其正常工作。
- 将包提交到npm注册表。更多信息请参考npm文档中的向注册表贡献包。
提交您的节点供n8n验证#
n8n审核验证社区节点。用户可以在n8n的节点面板中发现并安装经过验证的社区节点。这些节点需要符合特定的技术和用户体验标准及约束条件。
在将您的节点提交给n8n审核之前,您必须:
- 确保您的节点遵循已验证社区节点的技术指南且所有自动化检查均通过。特别需要注意的是,已验证社区节点不允许使用任何运行时依赖项。
- 确保您的节点遵循UX指南。
- 确保该节点在npm包或相关公共仓库中以README形式提供了适当的文档说明。
- 将您的节点提交到npm,因为n8n会从那里获取它进行最终审核。
如果您的节点满足以上所有要求,点击此处提交您的节点进行验证。