Skip to content

Versioning and release management ​

Concepts ​

  • Draft: editable working copy of an artifact. Version: a frozen published copy. Snapshot: a named copy of a whole plugin's source. Release: a plugin package at a version that has been installed.
  • Publish an artifact to freeze it; Publish a plugin to build, install and record a release.

Semantic versions ​

MAJOR.MINOR.PATCH.

1.0.0 -> 1.0.1 -> 1.1.0 -> 2.0.0
  • Patch: fixes, no visible change.
  • Minor: new things, compatible; extensions keep working.
  • Major: breaking (removed or renamed artifacts, changed fields, removed blocks). Extensions and overrides that point at what changed will be stopped by the upgrade guard or skipped and reported.

Operations ​

DoWhere
See or restore an artifact versiondesigner History tab
Snapshot / restore a pluginFile, Save snapshot / Restore snapshot
Raise the versionEdit, Plugin properties (or automatic on Publish)
Roll back the installed versionDeploy, Roll back installed version (one version)
Upgradeupload or Publish a higher version; check the guard's message
Downgrade / long-range migration toolingPlanned; use restore and reinstall for now

Compatibility ​

extendsVersionRange (for example >=2.0.0 <3.0.0) on extensions; erpVersion on the plugin; dependencies resolve before install.

Example ​

Base plugin 1.0 -> 1.5 (allowed: inside the extension's range) -> 2.0 (stopped, names the extension; upgrade the extension first or force, which is audited).

Deployment, Customize.