提交社区节点
社区节点是 npm 包,托管在 npm 注册表中。
在构建节点以提交到社区节点存储库时,请使用以下资源来确保您的节点设置正确:
- n8n 建议使用
n8n-nodeCLI 工具 来构建和测试您的节点。如果您计划使用 提交您的节点以供验证,这一点尤其重要。这可确保您的节点具有正确的结构并遵循社区节点要求。它还简化了 linting 和测试。 - 查看 n8n自有节点 以获取可在节点中使用的模式示例。
- 请参阅 构建自己的节点 的文档。
- 确保您的节点遵守以下社区节点标准。
标准
使用 n8n-node工具 进行开发可确保您的节点遵守以下标准,使您的节点在 n8n 社区节点存储库中可用:
- 确保包名称以
n8n-nodes-或@<scope>/n8n-nodes-开头。例如,n8n-nodes-weather或@weatherPlugins/n8n-nodes-weather。 - 在您的软件包关键字中包含
n8n-community-node-package。 - 确保将节点和凭据添加到
package.json文件中的n8n属性中。 - 使用 linter (
npm run lint) 检查您的节点并在本地测试 (npm run dev) 以确保其正常工作。 - 将包发布到 npm。如果您计划通过 n8n 创作者门户 提交节点进行验证,则必须使用 GitHub 操作工作流程和 出处声明 进行发布。请参阅下面的 发布到 npm。
发布到 npm
提示
创作者门户验证所需
从 2026 年 5 月 1 日起,提交验证的节点必须使用带有 出处声明 的 GitHub 操作来发布。 n8n 不会接受直接从本地计算机发布的已验证节点。
要通过 n8n Creator Portal 提交节点进行验证,请使用带有出处声明的 GitHub Actions 工作流程进行发布。 Provenance 允许任何人以加密方式验证特定工作流程是否从特定存储库构建了包并提交。 GitHub Actions 使用其 OIDC 基础设施签署出处声明。
新节点
如果您使用 npm create @n8n/node 搭建节点,则该搭建包括一个即用型 publish.yml 工作流程。在本地运行 npm run release 以更改版本、提交、标记和推送。这会触发工作流程发布到 npm。
现有节点
将 从 n8n-nodes-starter 发布工作流程 添加到位于 .github/workflows/publish.yml 的存储库。
另请确保您的项目具有 @n8n/node-cli 版本 0.23.0 或更高版本作为 devDependency,因为早期版本不支持工作流使用的出处标志:
npm list @n8n/node-cli
一次性设置
配置 npm 以信任存储库的 GitHub Actions 工作流程,以便它可以代表您发布。不需要长期令牌:
- 登录 npmjs.com 并打开包的设置。
- 在“发布访问 > 受信任的发布者”下,单击“添加发布者”。
- 选择GitHub 操作并填写:
- 存储库所有者:您的 GitHub 用户名或组织
- 存储库名称:您的存储库名称
- 工作流程名称:
publish.yml(文件名,而不是工作流程name:字段)
要使用令牌,请在 npmjs.com 上创建一个粒度访问令牌,并将其作为 NPM_TOKEN 存储在存储库的 Actions 密钥中。有关详细信息,请参阅工作流程文件中的注释。
提交您的节点以供 n8n 验证
n8n 审查经过验证的社区节点。用户可以从n8n中的节点面板发现并安装经过验证的社区节点。这些节点需要遵守某些技术和用户体验标准和约束。
提示
GitHub 验证需要发布操作
从 2026 年 5 月 1 日起,通过 n8n 创作者门户 提交验证的节点必须使用 GitHub Actions 进行发布并附上出处声明。有关设置说明,请参阅发布到 npm。
在提交您的节点供 n8n 审核之前,您必须:
- 从
n8n-node工具生成的脚手架开始。虽然这不是严格要求的,但 n8n 强烈建议对您计划提交验证的任何社区节点使用n8n-nodeCLI 工具。使用该工具可确保您的节点遵循预期约定并遵守社区节点要求。 - 确保您的节点遵循 已验证社区节点技术指南 并且所有自动检查都通过。具体来说,经过验证的社区节点不允许使用任何运行时依赖项。
- 确保您的节点遵循 用户体验指南。
- 确保节点在 npm 包 或相关公共存储库中具有 README 形式的适当文档。
- 使用具有出处的 GitHub Actions 工作流程将节点发布到 npm,如 发布到 npm 中所述。 n8n 将从那里获取它以进行最终审核。
准备好提交了吗?
如果您的节点满足以上所有要求,请注册或登录n8n 创作者门户并提交您的节点进行验证。
审核最长可能需要四周。提交在审核流程中推进时,n8n 会通过电子邮件通知你。
请注意,n8n 保留拒绝与 n8n 任何付费功能(尤其是企业功能)竞争的节点的权利。