6.0 KiB
Community nodes are npm packages, hosted in the npm registry.
When building a node to submit to the community node repository, use the following resources to make sure your node setup is correct:
- n8n recommends using the
n8n-nodeCLI tool to build and test your node. In particular, this is important if you plan on submitting your node for verification. This ensures that your node has the correct structure and follows community node requirements. It also simplifies linting and testing. - View n8n's own nodes for examples of patterns you can use in your nodes.
- Refer to the documentation on building your own nodes.
- Make sure your node follows the standards for community nodes.
Standards
Developing with the n8n-node tool ensures that your node adheres to the following standards required to make your node available in the n8n community node repository:
- Make sure the package name starts with
n8n-nodes-or@<scope>/n8n-nodes-. For example,n8n-nodes-weatheror@weatherPlugins/n8n-nodes-weather. - Include
n8n-community-node-packagein your package keywords. - Make sure that you add your nodes and credentials to the
package.jsonfile inside then8nattribute. - Check your node using the linter (
npm run lint) and test it locally (npm run dev) to ensure it works. - Publish the package to npm. If you plan to submit your node for verification through the n8n Creator Portal, you must publish using a GitHub Actions workflow with a provenance statement. See Publishing to npm below.
Publishing to npm
/// note | Required for Creator Portal verification From May 1st 2026, nodes submitted for verification must be published using GitHub Actions with a provenance statement. n8n won't accept verified nodes published directly from a local machine. ///
To submit your node for verification through the n8n Creator Portal, publish using a GitHub Actions workflow with a provenance statement. Provenance lets anyone cryptographically verify that a specific workflow built the package, from a specific repository and commit. GitHub Actions signs the provenance statement using its OIDC infrastructure.
New nodes
If you scaffold your node with npm create @n8n/node, the scaffolding includes a ready-to-use publish.yml workflow. Run npm run release locally to bump the version, commit, tag, and push. This triggers the workflow to publish to npm.
Existing nodes
Add the publish workflow from the n8n-nodes-starter to your repository at .github/workflows/publish.yml.
Also make sure your project has @n8n/node-cli version 0.23.0 or later as a devDependency, as earlier versions don't support the provenance flag used by the workflow:
npm list @n8n/node-cli
One-time setup
Configure npm to trust your repository's GitHub Actions workflow so it can publish on your behalf. No long-lived token required:
- Log in to npmjs.com and open your package's settings.
- Under Publish access > Trusted Publishers, click Add a publisher.
- Select GitHub Actions and fill in:
- Repository owner: your GitHub username or organisation
- Repository name: your repository name
- Workflow name:
publish.yml(the filename, not the workflowname:field)
To use a token instead, create a Granular Access Token on npmjs.com and store it as NPM_TOKEN in your repository's Actions secrets. See the comments in the workflow file for details.
Submit your node for verification by n8n
n8n vets verified community nodes. Users can discover and install verified community nodes from the nodes panel in n8n. These nodes need to adhere to certain technical and UX standards and constraints.
/// note | GitHub Actions publish required for verification From May 1st 2026, nodes submitted for verification through the n8n Creator Portal must be published using GitHub Actions with a provenance statement. See Publishing to npm for setup instructions. ///
Before submitting your node for review by n8n, you must:
- Start from the
n8n-nodetool generated scaffolding. While this isn't strictly required, n8n strongly suggests using then8n-nodeCLI tool for any community node you plan to submit for verification. Using the tool ensures that your node follows the expected conventions and adheres to the community node requirements. - Make sure that your node follows the technical guidelines for verified community nodes and that all automated checks pass. Specifically, verified community nodes aren't allowed to use any run-time dependencies.
- Ensure that your node follows the UX guidelines.
- Make sure that the node has appropriate documentation in the form of a README in the npm package or a related public repository.
- Publish your node to npm using a GitHub Actions workflow with provenance, as described in Publishing to npm. n8n will fetch it from there for final vetting.
Ready to submit?
If your node meets all the above requirements, sign up or log in to the n8n Creator Portal and submit your node for verification. Note that n8n reserves the right to reject nodes that compete with any of n8n's paid features, especially enterprise functionality.