Module versioning

SpotMe modules use the concept of semantic versioning for version numbers.

Using same rules for designating version numbers across modules allows us to know what scale of changes the update is going to bring simply by looking at the version number.

Every version number at SpotMe consists of three parts (numbers): 

• major: indicates an incompatible change
• minor: indicates a new capability, reset to 0 if major was increased
• patch: indicates a bug fix, reset to 0 if minor was increased

The version number is therefore written as major.minor.patch (ex. 4.12.3), and when our team is releasing a new version of a module, the version number is decided based on those rules.

For example:

• Updating a module from v3.2.1 to v3.2.2 means the updates include only bug fixes.
  
  
• Updating package from v3.2.1 to v3.3.0 means the update includes a brand new capability.
  This is generally safe, but it might also change or rename existing capabilities.
  
  
• Updating package from v3.2.1 to v4.0.0 means the new version is not compatible with previous one, either the data format, settings or functionality have changed drastically. Performing a major update on an existing workspace is generally not recommended due to changes this type of updates introduces for Backstage and app users. Backstage will warn you before doing an update like this.

Automatic module updates

Bug fixes (patch) are pushed automatically for non-live workspaces. For fixes on live workspaces, a notification will appear in Backstage mentioning that an update is pending.

Minor and major updates are not automatically pushed and such updates have to be manually accepted via the Marketplace.

We generally recommend to update modules as soon as possible, on both live and non-live workspaces, as this may include a bug fix or enable new functionalities. Of course, when you update a module on a live workspace, please check the release notes to see what the update entails.