提交社区节点#
社区节点是托管在 npm 注册表中的 npm 包。
在构建要提交到社区节点仓库的节点时,请使用以下资源确保您的节点设置正确:
- n8n 建议使用
n8n-nodeCLI 工具 来构建和测试您的节点。特别是如果您计划提交节点供 n8n 验证,这一点尤其重要。这确保您的节点具有正确的结构并遵循社区节点要求。它还简化了代码检查和测试。 - 查看 n8n 自己的节点 以获取可在您的节点中使用的模式示例。
- 参考关于构建您自己的节点的文档。
- 确保您的节点遵循社区节点的标准。
Standards 标准#
使用 n8n-node 工具 进行开发确保您的节点遵循以下标准,这些标准是使您的节点在 n8n 社区节点仓库中可用所必需的:
- 确保包名以
n8n-nodes-或@<scope>/n8n-nodes-开头。例如,n8n-nodes-weather或@weatherPlugins/n8n-nodes-weather。 - 在包的 keywords 中包含
n8n-community-node-package。 - 确保将节点和凭据添加到
package.json文件中的n8n属性内。 - 使用 linter 检查节点(
npm run lint)并在本地测试(npm run dev)以确保其正常工作。 - 将包发布到 npm。如果您计划通过 n8n Creator Portal 提交节点进行验证,则必须使用带有 provenance statement 的 GitHub Actions 工作流进行发布。请参阅下方的发布到 npm。
发布到 npm#
Creator Portal 验证要求
从 2026 年 5 月 1 日起,提交验证的节点必须使用带有 provenance statement 的 GitHub Actions 发布。n8n 不接受从本地机器直接发布的已验证节点。
要通过 n8n Creator Portal 提交节点进行验证,请使用带有 provenance statement 的 GitHub Actions 工作流进行发布。Provenance 允许任何人通过加密方式验证特定工作流从特定仓库和提交构建了该包。GitHub Actions 使用其 OIDC 基础设施签署 provenance statement。
新节点#
如果您使用 npm create @n8n/node 搭建节点脚手架,脚手架包含一个即用的 publish.yml 工作流。在本地运行 npm run release 来升级版本号、提交、打标签并推送。这将触发工作流发布到 npm。
现有节点#
将 n8n-nodes-starter 中的发布工作流 添加到您的仓库中的 .github/workflows/publish.yml。
同时确保您的项目将 @n8n/node-cli 版本 0.23.0 或更高版本作为 devDependency,因为早期版本不支持工作流使用的 provenance 标志:
1 | |
一次性设置#
配置 npm 信任您仓库的 GitHub Actions 工作流,使其可以代表您发布。无需长期有效的 token:
- 登录 npmjs.com 并打开包的设置。
- 在 Publish access > Trusted Publishers 下,点击 Add a publisher。
- 选择 GitHub Actions 并填写:
- Repository owner:您的 GitHub 用户名或组织名
- Repository name:您的仓库名称
- Workflow name:
publish.yml(文件名,而非工作流的name:字段)
如果要使用 token,请在 npmjs.com 上创建 Granular Access Token,并将其存储为仓库的 Actions secrets 中的 NPM_TOKEN。详情请参阅工作流文件中的注释。
Submit your node for verification by n8n 提交你的节点供 n8n 验证#
n8n 会审核已验证的社区节点。用户可以从 n8n 的节点面板中发现和安装已验证的社区节点。这些节点需要遵守特定的技术和用户体验标准与约束。
验证需要通过 GitHub Actions 发布
从 2026 年 5 月 1 日起,通过 n8n Creator Portal 提交验证的节点必须使用带有 provenance statement 的 GitHub Actions 发布。请参阅发布到 npm 了解设置说明。
在将节点提交给 n8n 审核之前,您必须:
- 从
n8n-node工具 生成的脚手架开始。虽然这不是严格要求的,但 n8n 强烈建议对任何计划提交验证的社区节点使用n8n-nodeCLI 工具。使用该工具可确保您的节点遵循预期的约定并符合社区节点要求。 - 确保您的节点遵循已验证社区节点的技术准则并且所有自动化检查均通过。特别是,已验证的社区节点不允许使用任何运行时依赖项。
- 确保您的节点遵循用户体验准则。
- 确保节点在 npm 包 或相关公共仓库中以 README 的形式提供适当的文档。
- 使用带有 provenance 的 GitHub Actions 工作流将节点发布到 npm,如发布到 npm 中所述。n8n 将从那里获取它进行最终审核。
Ready to submit? 准备提交?#
如果你的节点满足上述所有要求,请注册或登录 n8n Creator Portal 并提交你的节点进行验证。请注意,n8n 保留拒绝与 n8n 任何付费功能(尤其是企业功能)竞争的节点的权利。