mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
c10ff69d4e
n8n-docs/docs/integrations/creating-nodes/build/reference/node-versioning.md
Deborah Barnard 9be6875dd3 move ref into build
2022-07-04 19:09:44 +01:00

1.4 KiB
Raw Blame History

Node versioning

n8n supports node versioning. You can make changes to existing nodes without breaking the existing behavior by introducing a new version.

!!! note "Versioning type restricted by node style" If you build a node using the declarative style, you can't use full versioning.

Light versioning

This is available for all node types.

One node can contain more than one version, allowing small version increments without code duplication. To use this feature, change the version parameter in your node to an array, and add your version numbers, including your existing version. You can then access the version parameter with @version in your displayOptions (to control which version n8n displays). You can also query the version in your execute function using const nodeVersion = this.getNode().typeVersion;.

Full versioning

This isn't available for declarative-style nodes.

As an example, refer to the Mattermost node{:target=_blank .external-link}.

Node versioning summary:

  • The base node file should extend NodeVersionedType instead of INodeType.
  • The base node file should contain a description including the defaultVersion (usually the latest) and a list of versions. It shouldn't contain anything else.
  • n8n recommends using v1, v2, and so on, for version folder names.