Skip to main content
Use predictable release discipline to keep plugins stable across platform updates.

Versioning

Noxus uses semantic versioning for plugin packages. This is defined in your pyproject.toml or manifest.json.
# pyproject.toml
[project]
name = "weather-plugin"
version = "1.2.0" # Major.Minor.Patch

Release Strategy

1

Validate

Confirm the manifest, node definitions, and config schemas are valid.
noxus plugin validate --path ./my-plugin
2

Package

Build a .tar.gz for distribution.
noxus plugin package --path ./my-plugin --output my-plugin-1.2.0.tar.gz
3

Distribute

Install the new version into your Noxus deployment via one of:
  • Git — push the tagged release to your repository, then in the platform open Settings → Plugins → Install Plugin → Git and point it at the repo (with branch / commit / subpath as needed).
  • Upload — drag the .tar.gz into Settings → Plugins → Install Plugin → Upload.
  • Marketplace — open a PR to github.com/Noxus-AI/noxus-plugins so the new version is discoverable from the in-app marketplace.
For an existing plugin, use Reload on its row to pick up the new version without re-installing.

Compatibility Checklist

  • Inputs/Outputs: Never remove or rename existing inputs/outputs in a minor version; only add optional ones.
  • Config Migration: Provide default values for new configuration fields to avoid breaking existing deployments.
  • Deprecation: Mark old nodes as deprecated before removing them in a major version update.

Plugins Overview

Return to the full plugin development map.