集成节点/Creating_nodes/Deploy_your_node
提交社区节点#
社区节点是托管在 npm 注册表中的 npm 包。
在构建要提交至社区节点仓库的节点时,请使用以下资源确保节点配置正确:
- n8n 推荐使用
n8n-nodeCLI 工具 来构建和测试节点。如果您计划提交节点供 n8n 验证,这一点尤为重要。该工具能确保节点具有正确的结构并符合社区节点要求,同时还能简化代码检查和测试流程。 - 查看 n8n 官方节点示例,了解可在节点中使用的模式。
- 参考自定义节点开发文档。
- 确保节点遵循社区节点的标准规范。
标准规范#
使用 n8n-node 工具 进行开发可确保节点符合以下标准,从而使其有资格入选 n8n 社区节点仓库:
- 确保包名以
n8n-nodes-或@<scope>/n8n-nodes-开头,例如n8n-nodes-weather或@weatherPlugins/n8n-nodes-weather。 - 在包的 keywords 字段中包含
n8n-community-node-package。 - 确保在
package.json文件的n8n属性中添加节点和凭据信息。 - 使用 lint 工具(
npm run lint)检查节点,并通过本地测试(npm run dev)确保其正常运行。 - 将包提交至 npm 注册表。更多信息请参阅 npm 官方文档关于向注册表贡献包的说明。
向 n8n 提交节点验证#
n8n 会对经过验证的社区节点进行审核。用户可以从 n8n 的节点面板中发现并安装经过验证的社区节点。这些节点需要遵循特定的技术标准和用户体验规范。
在向 n8n 提交节点审核前,您必须:
- 基于
n8n-node工具生成的脚手架进行开发。虽然这不是强制要求,但 n8n 强烈建议对计划提交验证的任何社区节点使用n8n-nodeCLI 工具。使用该工具可确保您的节点遵循预期规范并符合社区节点要求。 - 确保您的节点遵循已验证社区节点的技术指南,且所有自动化检查均已通过。特别需要注意的是,经过验证的社区节点不允许使用任何运行时依赖。
- 确保您的节点符合用户体验指南。
- 确保节点在 npm 包或相关公共仓库中提供了格式规范的 README 文档。
- 将节点提交至 npm,n8n 将从该平台获取节点进行最终审核。
准备提交? 如果您的节点满足以上所有要求,请注册或登录 n8n 创作者门户并提交节点验证申请。请注意,n8n 保留拒绝与任何付费功能(特别是企业功能)存在竞争关系的节点的权利。
文档反馈 本页面 点赞有帮助 点踩无帮助 感谢您的反馈! 提交 上一页 部署节点 下一页 安装私有节点 基于 Material for MkDocs Insiders 构建